aiida.repository package

Module with resources dealing with the file repository.

class aiida.repository.File(name: str = '', file_type: aiida.repository.common.FileType = <FileType.DIRECTORY: 0>, type=None)

Bases: object

Data class representing a file object.

__dict__ = mappingproxy({'__module__': 'aiida.repository.common', '__doc__': 'Data class representing a file object.', '__init__': <function File.__init__>, 'name': <property object>, 'type': <property object>, 'file_type': <property object>, '__iter__': <function File.__iter__>, '__eq__': <function File.__eq__>, '__dict__': <attribute '__dict__' of 'File' objects>, '__weakref__': <attribute '__weakref__' of 'File' objects>, '__hash__': None})

__eq__(other)

Return self==value.

__hash__ = None

__init__(name: str = '', file_type: aiida.repository.common.FileType = <FileType.DIRECTORY: 0>, type=None)

Deprecated since version 1.4.0: The argument type has been deprecated and will be removed in v2.0.0, use file_type instead.

__iter__()

Iterate over the properties.

__module__ = 'aiida.repository.common'

__weakref__

list of weak references to the object (if defined)

property file_type

Return the file type of the file object.

property name

Return the name of the file object.

property type

Return the file type of the file object.

Deprecated since version 1.4.0: Will be removed in v2.0.0, use file_type instead.

class aiida.repository.FileType(value)

Bases: enum.Enum

Enumeration to represent the type of a file object.

DIRECTORY = 0

FILE = 1

__module__ = 'aiida.repository.common'

Submodules

Module with resources common to the repository.

class aiida.repository.common.File(name: str = '', file_type: aiida.repository.common.FileType = <FileType.DIRECTORY: 0>, type=None)

Bases: object

Data class representing a file object.

__dict__ = mappingproxy({'__module__': 'aiida.repository.common', '__doc__': 'Data class representing a file object.', '__init__': <function File.__init__>, 'name': <property object>, 'type': <property object>, 'file_type': <property object>, '__iter__': <function File.__iter__>, '__eq__': <function File.__eq__>, '__dict__': <attribute '__dict__' of 'File' objects>, '__weakref__': <attribute '__weakref__' of 'File' objects>, '__hash__': None})

__eq__(other)

Return self==value.

__hash__ = None

__init__(name: str = '', file_type: aiida.repository.common.FileType = <FileType.DIRECTORY: 0>, type=None)

Deprecated since version 1.4.0: The argument type has been deprecated and will be removed in v2.0.0, use file_type instead.

__iter__()

Iterate over the properties.

__module__ = 'aiida.repository.common'

__weakref__

list of weak references to the object (if defined)

property file_type

Return the file type of the file object.

property name

Return the name of the file object.

property type

Return the file type of the file object.

Deprecated since version 1.4.0: Will be removed in v2.0.0, use file_type instead.

class aiida.repository.common.FileType(value)

Bases: enum.Enum

Enumeration to represent the type of a file object.

DIRECTORY = 0

FILE = 1

__module__ = 'aiida.repository.common'

aiida.plugins package aiida.restapi package