aiida.tools.importexport.dbexport package

Provides export functionalities.

aiida.tools.importexport.dbexport.export(entities=None, filename=None, file_format=<ExportFileFormat.ZIP: 'zip'>, overwrite=False, silent=False, use_compression=True, **kwargs)[source]

Export AiiDA data

Deprecated since version 1.2.1: Support for the parameters what and outfile will be removed in v2.0.0. Please use entities and filename instead, respectively.

Parameters
  • entities (list) – a list of entity instances; they can belong to different models/entities.

  • filename (str) – the filename (possibly including the absolute path) of the file on which to export.

  • file_format (str, ExportFileFormat) – See ExportFileFormat for complete list of valid values (default: ‘zip’).

  • overwrite (bool) – if True, overwrite the output file without asking, if it exists. If False, raise an ArchiveExportError if the output file already exists.

  • silent (bool) – suppress console prints and progress bar.

  • use_compression (bool) – Whether or not to compress the archive file (only valid for the zip file format).

  • allowed_licenses (list) – List or function. If a list, then checks whether all licenses of Data nodes are in the list. If a function, then calls function for licenses of Data nodes expecting True if license is allowed, False otherwise.

  • forbidden_licenses (list) – List or function. If a list, then checks whether all licenses of Data nodes are in the list. If a function, then calls function for licenses of Data nodes expecting True if license is allowed, False otherwise.

  • include_comments (bool) – In-/exclude export of comments for given node(s) in entities. Default: True, include comments in export (as well as relevant users).

  • include_logs (bool) – In-/exclude export of logs for given node(s) in entities. Default: True, include logs in export.

  • kwargs – graph traversal rules. See aiida.common.links.GraphTraversalRules what rule names are toggleable and what the defaults are.

Raises
class aiida.tools.importexport.dbexport.ExportFileFormat[source]

Bases: str, enum.Enum

Export file formats

TAR_GZIPPED = 'tar.gz'
ZIP = 'zip'
__dict__ = mappingproxy({'_generate_next_value_': <function Enum._generate_next_value_>, '__module__': 'aiida.tools.importexport.dbexport.utils', '__doc__': 'Export file formats', '__dict__': <attribute '__dict__' of 'ExportFileFormat' objects>, '__weakref__': <attribute '__weakref__' of 'ExportFileFormat' objects>, '_member_names_': ['ZIP', 'TAR_GZIPPED'], '_member_map_': OrderedDict([('ZIP', <ExportFileFormat.ZIP: 'zip'>), ('TAR_GZIPPED', <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>)]), '_member_type_': <class 'str'>, '_value2member_map_': {'zip': <ExportFileFormat.ZIP: 'zip'>, 'tar.gz': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>}, 'ZIP': <ExportFileFormat.ZIP: 'zip'>, 'TAR_GZIPPED': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, '__repr__': <function Enum.__repr__>, '__str__': <function Enum.__str__>, '__format__': <function Enum.__format__>, '__new__': <function Enum.__new__>})
__module__ = 'aiida.tools.importexport.dbexport.utils'
__weakref__

list of weak references to the object (if defined)

_generate_next_value_(start, count, last_values)
_member_map_ = {'TAR_GZIPPED': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, 'ZIP': <ExportFileFormat.ZIP: 'zip'>}
_member_names_ = ['ZIP', 'TAR_GZIPPED']
_member_type_

alias of builtins.str

_value2member_map_ = {'tar.gz': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, 'zip': <ExportFileFormat.ZIP: 'zip'>}

Submodules

Utility functions for export of AiiDA entities

class aiida.tools.importexport.dbexport.utils.ExportFileFormat[source]

Bases: str, enum.Enum

Export file formats

TAR_GZIPPED = 'tar.gz'
ZIP = 'zip'
__dict__ = mappingproxy({'_generate_next_value_': <function Enum._generate_next_value_>, '__module__': 'aiida.tools.importexport.dbexport.utils', '__doc__': 'Export file formats', '__dict__': <attribute '__dict__' of 'ExportFileFormat' objects>, '__weakref__': <attribute '__weakref__' of 'ExportFileFormat' objects>, '_member_names_': ['ZIP', 'TAR_GZIPPED'], '_member_map_': OrderedDict([('ZIP', <ExportFileFormat.ZIP: 'zip'>), ('TAR_GZIPPED', <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>)]), '_member_type_': <class 'str'>, '_value2member_map_': {'zip': <ExportFileFormat.ZIP: 'zip'>, 'tar.gz': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>}, 'ZIP': <ExportFileFormat.ZIP: 'zip'>, 'TAR_GZIPPED': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, '__repr__': <function Enum.__repr__>, '__str__': <function Enum.__str__>, '__format__': <function Enum.__format__>, '__new__': <function Enum.__new__>})
__module__ = 'aiida.tools.importexport.dbexport.utils'
__weakref__

list of weak references to the object (if defined)

_generate_next_value_(start, count, last_values)
_member_map_ = {'TAR_GZIPPED': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, 'ZIP': <ExportFileFormat.ZIP: 'zip'>}
_member_names_ = ['ZIP', 'TAR_GZIPPED']
_member_type_

alias of builtins.str

_value2member_map_ = {'tar.gz': <ExportFileFormat.TAR_GZIPPED: 'tar.gz'>, 'zip': <ExportFileFormat.ZIP: 'zip'>}
aiida.tools.importexport.dbexport.utils.check_licenses(node_licenses, allowed_licenses, forbidden_licenses)[source]

Check licenses

aiida.tools.importexport.dbexport.utils.check_process_nodes_sealed(nodes)[source]

Check ProcessNode s are sealed Only sealed ProcessNode s may be exported.

Parameters

nodes (list, int) – ProcessNode s to be checked. Should be their PK(s).

Raises

ExportValidationError – if a ProcessNode is not sealed or nodes is not a list, set, or int.

aiida.tools.importexport.dbexport.utils.deprecated_parameters(old, new)[source]

Handle deprecated parameter (where it is replaced with another)

Parameters
  • old (dict) – The old, deprecated parameter as a dict with keys “name” and “value”

  • new (dict) – The new parameter as a dict with keys “name” and “value”

Returns

New parameter’s value (if not defined, then old parameter’s value)

aiida.tools.importexport.dbexport.utils.fill_in_query(partial_query, originating_entity_str, current_entity_str, tag_suffixes=None, entity_separator='_')[source]

This function recursively constructs QueryBuilder queries that are needed for the SQLA export function. To manage to construct such queries, the relationship dictionary is consulted (which shows how to reference different AiiDA entities in QueryBuilder. To find the dependencies of the relationships of the exported data, the get_all_fields_info (which described the exported schema and its dependencies) is consulted.

aiida.tools.importexport.dbexport.utils.serialize_dict(datadict, remove_fields=None, rename_fields=None, track_conversion=False)[source]

Serialize the dict using the serialize_field function to serialize each field.

Parameters
  • remove_fields

    a list of strings. If a field with key inside the remove_fields list is found, it is removed from the dict.

    This is only used at level-0, no removal is possible at deeper levels.

  • rename_fields

    a dictionary in the format {"oldname": "newname"}.

    If the “oldname” key is found, it is replaced with the “newname” string in the output dictionary.

    This is only used at level-0, no renaming is possible at deeper levels.

  • track_conversion – if True, a tuple is returned, where the first element is the serialized dictionary, and the second element is a dictionary with the information on the serialized fields.

aiida.tools.importexport.dbexport.utils.serialize_field(data, track_conversion=False)[source]

Serialize a single field.

Todo

Generalize such that it the proper function is selected also during import

aiida.tools.importexport.dbexport.utils.summary(file_format, outfile, **kwargs)[source]

Print summary for export

Export a zip-file.

class aiida.tools.importexport.dbexport.zip.MyWritingZipFile(zip_file, fname)[source]

Bases: object

__dict__ = mappingproxy({'__module__': 'aiida.tools.importexport.dbexport.zip', '__init__': <function MyWritingZipFile.__init__>, 'open': <function MyWritingZipFile.open>, 'write': <function MyWritingZipFile.write>, 'close': <function MyWritingZipFile.close>, '__enter__': <function MyWritingZipFile.__enter__>, '__exit__': <function MyWritingZipFile.__exit__>, '__dict__': <attribute '__dict__' of 'MyWritingZipFile' objects>, '__weakref__': <attribute '__weakref__' of 'MyWritingZipFile' objects>, '__doc__': None})
__enter__()[source]
__exit__(type, value, traceback)[source]
__init__(zip_file, fname)[source]

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'aiida.tools.importexport.dbexport.zip'
__weakref__

list of weak references to the object (if defined)

close()[source]
open()[source]
write(data)[source]
class aiida.tools.importexport.dbexport.zip.ZipFolder(zipfolder_or_fname, mode=None, subfolder='.', use_compression=True, allowZip64=True)[source]

Bases: object

To improve: if zipfile is closed, do something (e.g. add explicit open method, rename open to openfile, set _zipfile to None, …)

__dict__ = mappingproxy({'__module__': 'aiida.tools.importexport.dbexport.zip', '__doc__': '\n To improve: if zipfile is closed, do something\n (e.g. add explicit open method, rename open to openfile,\n set _zipfile to None, ...)\n ', '__init__': <function ZipFolder.__init__>, '__enter__': <function ZipFolder.__enter__>, '__exit__': <function ZipFolder.__exit__>, 'close': <function ZipFolder.close>, 'pwd': <property object>, 'open': <function ZipFolder.open>, '_get_internal_path': <function ZipFolder._get_internal_path>, 'get_subfolder': <function ZipFolder.get_subfolder>, 'exists': <function ZipFolder.exists>, 'insert_path': <function ZipFolder.insert_path>, '__dict__': <attribute '__dict__' of 'ZipFolder' objects>, '__weakref__': <attribute '__weakref__' of 'ZipFolder' objects>})
__enter__()[source]
__exit__(type, value, traceback)[source]
__init__(zipfolder_or_fname, mode=None, subfolder='.', use_compression=True, allowZip64=True)[source]
Parameters
  • zipfolder_or_fname – either another ZipFolder instance, of which you want to get a subfolder, or a filename to create.

  • mode – the file mode; see the zipfile.ZipFile docs for valid strings. Note: can be specified only if zipfolder_or_fname is a string (the filename to generate)

  • subfolder – the subfolder that specified the “current working directory” in the zip file. If zipfolder_or_fname is a ZipFolder, subfolder is a relative path from zipfolder_or_fname.subfolder

  • use_compression – either True, to compress files in the Zip, or False if you just want to pack them together without compressing. It is ignored if zipfolder_or_fname is a ZipFolder isntance.

__module__ = 'aiida.tools.importexport.dbexport.zip'
__weakref__

list of weak references to the object (if defined)

_get_internal_path(filename)[source]
close()[source]
exists(path)[source]

Check whether path already exists in the ZipFolder

get_subfolder(subfolder, create=False, reset_limit=False)[source]
insert_path(src, dest_name=None, overwrite=True)[source]
open(fname, mode='r')[source]
property pwd