gpf.gpf_instance_plugin package

Submodules

gpf.gpf_instance_plugin.gpf_instance_context_plugin module

class gpf.gpf_instance_plugin.gpf_instance_context_plugin.GPFInstanceContextProvider

Bases: GenomicContextProvider

Defines GPFInstance genomic context provider.

add_argparser_arguments(parser: ArgumentParser, **kwargs: Any) → None

Add command line arguments to the argument parser.

init(**kwargs: Any) → GenomicContext | None

Initialize the GPF instance genomic context.

class gpf.gpf_instance_plugin.gpf_instance_context_plugin.GPFInstanceGenomicContext(gpf_instance: Any)

Bases: GenomicContext

Defines GPFInstance genomic context.

get_context_keys() → set[str]

Report all keys exposed by this context.

Returns

set[str]

The complete collection of keys under which objects can be retrieved. May be empty if the context holds no resources.

get_context_object(key: str) → Any | None

Retrieve a context object by its key.

Parameters

key

The string identifier for the desired resource.

Returns

Any | None

The stored object if the key is present, otherwise None.

Notes

Implementations must return None when the key is absent rather than raising KeyError. This convention allows callers to safely query for optional resources.

get_source() → str

Identify the origin of this context.

Returns

str

A human-readable label describing the source, such as a provider name or a file path. Useful for debugging and logging when multiple contexts are combined.

Module contents