is_test

Is the S3Path a XYZ testing.

• is_void()

• is_dir()

• is_file()

• is_bucket()

class s3pathlib.core.is_test.IsTestAPIMixin

A mixin class that implements the condition test methods.

is_void() → bool

Test if it is a void S3 path.

Definition

no bucket, no key, no parts, no type, no nothing. A void path is also a special relative path, because any path join with void path results to itself.

is_dir() → bool

Test if it is a S3 directory

Definition

A logical S3 directory that never physically exists. An S3 bucket is also a special dir, which is the root dir.

Added in version 1.0.1.

is_file() → bool

Test if it is a S3 object

Definition

A S3 object.

Added in version 1.0.1.

is_bucket() → bool

Test if it is a S3 bucket.

Definition

A S3 bucket, the root folder S3 path is equivalent to a S3 bucket. A S3 bucket are always is_dir() is True

Added in version 1.0.1.

is_delete_marker() → bool

Test if it is a delete-marker. A delete-marker is just a version of an object without content.

Added in version 2.0.1.

ensure_object() → None

A validator method that ensure it represents a S3 object.

Added in version 1.0.1.

ensure_file() → None

A validator method that ensure it represents a S3 object.

Added in version 1.2.1.

ensure_not_object() → None

A validator method that ensure it IS NOT a S3 object.

Added in version 1.2.1.

ensure_not_file() → None

A validator method that ensure it IS NOT a S3 object.

Added in version 1.2.1.

ensure_dir() → None

A validator method that ensure it represents a S3 dir.

Added in version 1.0.1.

ensure_not_dir() → None

A validator method that ensure it IS NOT a S3 dir.

Added in version 1.2.1.

ensure_bucket() → None

A validator method that ensure it represents a S3 bucket.

Added in version 2.1.1.