earthkit.data.sources.file¶

Attributes¶

source

Classes¶

`File`	Base class for all sources.
`FileSource`	Base class for all sources.
`FileSourcePathAndParts`
`IndexedFileSource`	Base class for all sources.
`SingleStreamFileSource`
`StreamFileSource`	Base class for all sources.

Module Contents¶

class earthkit.data.sources.file.File(path, expand_user=True, expand_vars=False, unix_glob=True, recursive_glob=True, filter=None, merger=None, **kwargs)¶

Bases: FileSource

Base class for all sources.

content_type = None¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

property path¶

source_filename = None¶

stream = False¶

to_data_object()¶: Convert this source into a data object, if possible.

to_target(*args, **kwargs)¶

class earthkit.data.sources.file.FileSource(path=None, filter=None, merger=None, parts=None, stream=False, **kwargs)¶

Bases: earthkit.data.sources.Source, earthkit.data.core.Encodable, os.PathLike

Base class for all sources.

content_type = None¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

property path¶

source_filename = None¶

stream = False¶

to_data_object()¶: Convert this source into a data object, if possible.

to_target(*args, **kwargs)¶

class earthkit.data.sources.file.FileSourcePathAndParts(path, parts)¶

Bases: earthkit.data.utils.parts.PathAndParts

compress = False¶

classmethod from_paths(path, parts)¶

is_empty()¶

parts¶

path¶

sequence = False¶

sorted()¶

update(path)¶

zipped()¶

class earthkit.data.sources.file.IndexedFileSource(path=None, filter=None, merger=None, parts=None, stream=False, **kwargs)¶

Bases: FileSource

Base class for all sources.

content_type = None¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

property path¶

source_filename = None¶

stream = False¶

to_data_object()¶: Convert this source into a data object, if possible.

to_target(*args, **kwargs)¶

class earthkit.data.sources.file.SingleStreamFileSource(path, parts)¶

parts¶

path¶

to_stream()¶

class earthkit.data.sources.file.StreamFileSource(path_and_parts, **kwargs)¶

Bases: FileSource

Base class for all sources.

content_type = None¶

filter = None¶

graph(depth=0)¶

ignore()¶

Indicates to ignore this source in concatenation/merging.

Return type:: bool

classmethod merge(sources)¶

merger = None¶

mutate()¶

mutate_source()¶

name = None¶

property parent¶: The parent source, if any.

property parts¶

property path¶

source_filename = None¶

stream = False¶

to_data_object()¶: Convert this source into a data object, if possible.

to_target(*args, **kwargs)¶

earthkit.data.sources.file.source¶