poiesis.core.services.filer package

Subpackages

• poiesis.core.services.filer.strategy package
  • Submodules
  • poiesis.core.services.filer.strategy.content_filer module
    • ContentFilerStrategy
      • ContentFilerStrategy.download_input_directory()
      • ContentFilerStrategy.download_input_file()
      • ContentFilerStrategy.upload_glob()
      • ContentFilerStrategy.upload_output_directory()
      • ContentFilerStrategy.upload_output_file()
  • poiesis.core.services.filer.strategy.filer_strategy module
    • FilerStrategy
      • FilerStrategy.download()
      • FilerStrategy.download_input_directory()
      • FilerStrategy.download_input_file()
      • FilerStrategy.upload()
      • FilerStrategy.upload_glob()
      • FilerStrategy.upload_output_directory()
      • FilerStrategy.upload_output_file()
  • poiesis.core.services.filer.strategy.http_filer module
    • HttpFilerStrategy
      • HttpFilerStrategy.download_input_directory()
      • HttpFilerStrategy.download_input_file()
      • HttpFilerStrategy.upload_glob()
      • HttpFilerStrategy.upload_output_directory()
      • HttpFilerStrategy.upload_output_file()
  • poiesis.core.services.filer.strategy.local_filer module
    • LocalFilerStrategy
      • LocalFilerStrategy.download_input_directory()
      • LocalFilerStrategy.download_input_file()
      • LocalFilerStrategy.upload_glob()
      • LocalFilerStrategy.upload_output_directory()
      • LocalFilerStrategy.upload_output_file()
  • poiesis.core.services.filer.strategy.s3_filer module
    • S3FilerStrategy
      • S3FilerStrategy.download_input_directory()
      • S3FilerStrategy.download_input_file()
      • S3FilerStrategy.upload_glob()
      • S3FilerStrategy.upload_output_directory()
      • S3FilerStrategy.upload_output_file()
  • Module contents

Submodules

poiesis.core.services.filer.filer module

Interface for TIF and TOF.

class poiesis.core.services.filer.filer.Filer

Bases: ABC

Interface for TIF and TOF.

message_broker

Message broker

name

Name of the filer

async execute()

Execute the filer.

This will file the file and send a message to TORC via the message broker.

abstractmethod async file()

Filing logic, upload or download.

If TIF encounters any error, it will send a message to TORC and break.

message(message)

Message logic, send a message to TORC.

abstract property name: str

Name of the filer.

poiesis.core.services.filer.filer_strategy_factory module

Filer strategy factory module.

Get the correct strategy based on the URI scheme.

class poiesis.core.services.filer.filer_strategy_factory.FilerStrategyFactory

Bases: object

Factory for creating filer strategies based on URI scheme.

This factory class provides a method to create appropriate filer strategy instances based on the URI scheme provided.

STRATEGY_MAP

A mapping of URI schemes to their corresponding filer strategy classes.

classmethod create_strategy(uri, payload)

Create appropriate strategy based on URI scheme.

Parameters:

• uri (str) – The URI string to determine the strategy.

• payload (TesInput or TesOutput) – The payload to instantiate the strategy implementation.

Returns:

An instance of the appropriate filer strategy.

Return type:

FilerStrategy

Example

>>> strategy = FilerStrategyFactory.create_strategy("s3://mybucket/myfile")
>>> isinstance(strategy, S3FilerStrategy)
True

Note

If the URI scheme is not recognized, the LocalFilerStrategy will be used as the default strategy.

class poiesis.core.services.filer.filer_strategy_factory.StrategyInfoDict(**data)

Bases: BaseModel

Typed dictionary for strategy mapping.

input: bool

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

output: bool

strategy: type[FilerStrategy]

poiesis.core.services.filer.tif module

Entry point for the TIF service.

class poiesis.core.services.filer.tif.Tif(name, inputs)

Bases: Filer

Task input filer.

Parameters:

• name (str) – Name of the task.

• inputs (list[TesInput]) – List of task inputs.

name

Name of the task.

inputs

List of task inputs.

message_broker

Message broker.

async file()

Filing logic, download.

Raises:

Exception – If the file cannot be downloaded.

Return type:

None

property name: str

Name of the filer.

poiesis.core.services.filer.tof module

Entry point for the TOF service.

class poiesis.core.services.filer.tof.Tof(name, outputs)

Bases: Filer

Task output filer.

Parameters:

• name (str) – Name of the task.

• outputs (list[TesOutput]) – List of task outputs.

name

Name of the task.

outputs

List of task outputs.

message_broker

Message broker

async file()

Filing logic, upload.

Raises:

Exception – If the file cannot be uploaded.

Return type:

None

property name: str

Name of the filer.

Module contents

Filer module.