libera_utils.io.filenaming.AbstractValidFilename#

class libera_utils.io.filenaming.AbstractValidFilename(*args, **kwargs)#

Bases: ABC

Composition of a CloudPath/Path instance with some methods to perform regex validation on filenames

Attributes:

archive_prefix: Property that contains the generated prefix used for archiving, when applicable
data_product_id: Property that contains the DataProductIdentifier for this file type
filename_parts: Property that contains a namespace of filename parts
path: Property containing the file path
processing_step_id: Property that contains the ProcessingStepIdentifier that generates this file

Methods

`from_file_path`(args, *kwargs)	Factory method to produce an AbstractValidFilename from a valid Libera file path (str or Path)
`from_filename_parts`(*args[, basepath])	Abstract method that must be implemented to provide hinting for required parts
`generate_prefixed_path`(parent_path)	Generates an absolute path of the form {parent_path}/{prefix_structure}/{file_basename} The parent_path can be an S3 bucket or an absolute local filepath (must start with /)
`regex_match`(path)	Parse and validate a given path against class-attribute defined regex

__init__(*args, **kwargs)#

Methods

`from_file_path`(args, *kwargs)	Factory method to produce an AbstractValidFilename from a valid Libera file path (str or Path)
`from_filename_parts`(*args[, basepath])	Abstract method that must be implemented to provide hinting for required parts
`generate_prefixed_path`(parent_path)	Generates an absolute path of the form {parent_path}/{prefix_structure}/{file_basename} The parent_path can be an S3 bucket or an absolute local filepath (must start with /)
`regex_match`(path)	Parse and validate a given path against class-attribute defined regex

Attributes

`archive_prefix`	Property that contains the generated prefix used for archiving, when applicable
`data_product_id`	Property that contains the DataProductIdentifier for this file type
`filename_parts`	Property that contains a namespace of filename parts
`path`	Property containing the file path
`processing_step_id`	Property that contains the ProcessingStepIdentifier that generates this file

static _calculate_applicable_time(start: datetime, end: datetime) → date#

Based on the start time and end time of a file, returns the applicable time (date)

Parameters:

start (datetime.datetime) – Start of the applicable time range
end (datetime.datetime) – End of the applicable time range

Returns:

The date of the mean time between start and end

Return type:

datetime.date

abstract classmethod _format_filename_parts(**parts)#

Format parts into a filename

Note: When this is implemented by concrete classes, **parts becomes a set of explicitly named arguments

classmethod _from_filename_parts(*, basepath: str | Path | S3Path = None, **parts: Any)#

Create instance from filename parts.

The part kwarg names are named according to the regex for the file type.

Parameters:

basepath (Union[str, Path, S3Path], Optional) – Allows prepending a basepath or prefix.
parts (Any) – Passed directly to _format_filename_parts. This is a dict of variable kwargs that will differ in each filename class based on the required parts for that particular filename type.

Return type:

AbstractValidFilename

abstract _parse_filename_parts()#

Parse the filename parts into objects from regex matched strings

Returns:: namespace object containing filename parts as parsed objects
Return type:: types.SimpleNamespace

abstract property archive_prefix: str#: Property that contains the generated prefix used for archiving, when applicable

abstract property data_product_id: DataProductIdentifier#: Property that contains the DataProductIdentifier for this file type

property filename_parts#: Property that contains a namespace of filename parts

classmethod from_file_path(*args, **kwargs) → AVF#: Factory method to produce an AbstractValidFilename from a valid Libera file path (str or Path)

abstract classmethod from_filename_parts(*args: Any, basepath: str | Path | S3Path = None, **kwargs: Any)#: Abstract method that must be implemented to provide hinting for required parts

generate_prefixed_path(parent_path: str | Path | S3Path) → Path | S3Path#

Generates an absolute path of the form {parent_path}/{prefix_structure}/{file_basename} The parent_path can be an S3 bucket or an absolute local filepath (must start with /)

Parameters:: parent_path (Union[str, Path, S3Path]) – Absolute path to the parent directory or S3 bucket prefix. The generated path prefix is appended to the parent path and followed by the file basename.
Return type:: pathlib.Path or cloudpathlib.s3.s3path.S3Path

property path: Path | S3Path#: Property containing the file path

abstract property processing_step_id: ProcessingStepIdentifier#: Property that contains the ProcessingStepIdentifier that generates this file

regex_match(path: str | Path | S3Path)#

Parse and validate a given path against class-attribute defined regex

Returns:: Match group dict of filename parts
Return type:: dict