aiida.common

Package Contents

Classes

Functions

Data

API

aiida.common.AIIDA_LOGGER = None
exception aiida.common.AiidaException

Bases: Exception

Initialization

class aiida.common.AttributeDict(dictionary=None)

Bases: dict

Initialization

__repr__()
__getattr__(attr)
__setattr__(attr, value)
__delattr__(attr)
__deepcopy__(memo=None)
__getstate__()
__setstate__(dictionary)
__dir__()
class aiida.common.CalcInfo(dictionary=None)

Bases: aiida.common.extendeddicts.DefaultFieldsAttributeDict

Initialization

_default_fields = ('job_environment', 'email', 'email_on_started', 'email_on_terminated', 'uuid', 'prepend_text', 'app...
class aiida.common.CalcJobState(*args, **kwds)

Bases: enum.Enum

Initialization

UPLOADING = 'uploading'
SUBMITTING = 'submitting'
WITHSCHEDULER = 'withscheduler'
STASHING = 'stashing'
RETRIEVING = 'retrieving'
PARSING = 'parsing'
exception aiida.common.ClosedStorage

Bases: aiida.common.exceptions.AiidaException

Initialization

class aiida.common.CodeInfo(dictionary=None)

Bases: aiida.common.extendeddicts.DefaultFieldsAttributeDict

Initialization

_default_fields = ('cmdline_params', 'stdin_name', 'stdout_name', 'stderr_name', 'join_files', 'withmpi', 'code_uuid')
class aiida.common.CodeRunMode

Bases: enum.IntEnum

Initialization

SERIAL = 0
PARALLEL = 1
exception aiida.common.ConfigurationError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.ConfigurationVersionError

Bases: aiida.common.exceptions.ConfigurationError

Initialization

exception aiida.common.ContentNotExistent

Bases: aiida.common.exceptions.NotExistent

Initialization

exception aiida.common.CorruptStorage

Bases: aiida.common.exceptions.ConfigurationError

Initialization

exception aiida.common.DbContentError

Bases: aiida.common.exceptions.AiidaException

Initialization

class aiida.common.DefaultFieldsAttributeDict(dictionary=None)

Bases: aiida.common.extendeddicts.AttributeDict

Initialization

_default_fields = None
validate()
__setattr__(attr, value)
__getitem__(key)
classmethod get_default_fields()
defaultkeys()
extrakeys()
exception aiida.common.EntryPointError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.FailedError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.FeatureDisabled

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.FeatureNotAvailable

Bases: aiida.common.exceptions.AiidaException

Initialization

class aiida.common.FixedFieldsAttributeDict(init=None)

Bases: aiida.common.extendeddicts.AttributeDict

Initialization

_valid_fields = None
__setitem__(item, value)
__setattr__(attr, value)
classmethod get_valid_fields()
__dir__()
aiida.common.GraphTraversalRule = None
class aiida.common.GraphTraversalRules(*args, **kwds)

Bases: enum.Enum

Initialization

DEFAULT = None
DELETE = None
EXPORT = None
exception aiida.common.HashingError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.IncompatibleStorageSchema

Bases: aiida.common.exceptions.IncompatibleDatabaseSchema

Initialization

exception aiida.common.InputValidationError

Bases: aiida.common.exceptions.ValidationError

Initialization

exception aiida.common.IntegrityError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.InternalError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.InvalidEntryPointTypeError

Bases: aiida.common.exceptions.EntryPointError

Initialization

exception aiida.common.InvalidOperation

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.LicensingException

Bases: aiida.common.exceptions.AiidaException

Initialization

class aiida.common.LinkType(*args, **kwds)

Bases: enum.Enum

Initialization

CREATE = 'create'
RETURN = 'return'
INPUT_CALC = 'input_calc'
INPUT_WORK = 'input_work'
CALL_CALC = 'call_calc'
CALL_WORK = 'call_work'
exception aiida.common.LoadingEntryPointError

Bases: aiida.common.exceptions.EntryPointError

Initialization

exception aiida.common.LockedProfileError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.LockingProfileError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.MissingConfigurationError

Bases: aiida.common.exceptions.ConfigurationError

Initialization

exception aiida.common.MissingEntryPointError

Bases: aiida.common.exceptions.EntryPointError

Initialization

exception aiida.common.ModificationNotAllowed

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.MultipleEntryPointError

Bases: aiida.common.exceptions.EntryPointError

Initialization

exception aiida.common.MultipleObjectsError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.NotExistent

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.NotExistentAttributeError

Bases: AttributeError, aiida.common.exceptions.NotExistent

Initialization

exception aiida.common.NotExistentKeyError

Bases: KeyError, aiida.common.exceptions.NotExistent

Initialization

exception aiida.common.OutputParsingError

Bases: aiida.common.exceptions.ParsingError

Initialization

exception aiida.common.ParsingError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.PluginInternalError

Bases: aiida.common.exceptions.InternalError

Initialization

exception aiida.common.ProfileConfigurationError

Bases: aiida.common.exceptions.ConfigurationError

Initialization

class aiida.common.ProgressReporterAbstract(*, total: int, desc: Optional[str] = None, **kwargs: Any)

Initialization

property total: int
property desc: Optional[str]
property n: int
__enter__() aiida.common.progress_reporter.ProgressReporterAbstract
__exit__(exctype: Optional[Type[BaseException]], excinst: Optional[BaseException], exctb: Optional[types.TracebackType])
set_description_str(text: Optional[str] = None, refresh: bool = True)
update(n: int = 1)
reset(total: Optional[int] = None)
exception aiida.common.RemoteOperationError

Bases: aiida.common.exceptions.AiidaException

Initialization

class aiida.common.StashMode(*args, **kwds)

Bases: enum.Enum

Initialization

COPY = 'copy'
exception aiida.common.StorageMigrationError

Bases: aiida.common.exceptions.DatabaseMigrationError

Initialization

exception aiida.common.StoringNotAllowed

Bases: aiida.common.exceptions.AiidaException

Initialization

aiida.common.TQDM_BAR_FORMAT = '{desc:40.40}{percentage:6.1f}%|{bar}| {n_fmt}/{total_fmt}'
exception aiida.common.TestsNotAllowedError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.TransportTaskException

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.UniquenessError

Bases: aiida.common.exceptions.AiidaException

Initialization

exception aiida.common.UnsupportedSpeciesError

Bases: ValueError

Initialization

exception aiida.common.ValidationError

Bases: aiida.common.exceptions.AiidaException

Initialization

aiida.common.create_callback(progress_reporter: aiida.common.progress_reporter.ProgressReporterAbstract) Callable[[str, Any], None]
aiida.common.get_progress_reporter() Type[aiida.common.progress_reporter.ProgressReporterAbstract]
aiida.common.override_log_level(level=logging.CRITICAL)
aiida.common.set_progress_bar_tqdm(bar_format: Optional[str] = TQDM_BAR_FORMAT, leave: Optional[bool] = False, **kwargs: Any)
aiida.common.set_progress_reporter(reporter: Optional[Type[aiida.common.progress_reporter.ProgressReporterAbstract]] = None, **kwargs: Any)