netx defined

netx defined networkformat

Netx.Defined(networkformat)

A boolean check whether the network format is supported by a module. If the format is not yet known, an attempt is made to locate and auto-load the module. For an equivalent command without auto-loading, see netx exists . The name can be the primary name of the format, or any recognized alias.

netx exists

netx exists networkformat

n.exists()

Netx.Exists(networkformat)

A boolean check whether the network format is supported by a module. No attempt is made to auto-load a handler module if it is not already in memory. The name can be the primary name of the format, or any recognized alias. For an equivalent command with auto-loading, see netx defined .

netx get

netx get networkformat attribute

Netx.Get(networkformat,attribute)

n.get(attribute)

n.attribute

n[attribute]

Query the value of an attribute of the module Note that network format handlers are static - it is neither possible to define them on the command line, nor to change any attribute. Therefore, there are no netx create or netx set commands.

The following attributes are recognized:

• address_city
  The city part of the author contact address.
• address_country
  The country part of the author contact address, following the ISO3166 standard.
• address_state
  The state part of the author contact address. Empty if not applicable.
• address_street
  The street address part of the author contact address. Includes floor, house number, etc.
• address_zip
  The ZIP code or other applicable postal code of the author contact address.
• aliases
  A list of recognized alias names of the format.
• affiliation
  The institution the author works for.
• affiliationduns
  The DUNS registration ID of the affiliated institution. This is primarily useful for US government projects.
• affiliationurl
  The URL of the affiliated institution.
• author
  The author of the module, as free-format text.
• authorurl
  A URL with information on the author, or an empty string if unset.
• builtin
  A boolean flag indicating whether this is a built-in type.
• capabiltities
  A collection of flags reporting specific attributes of the module. The currently supported set is:
• none
  No flags.
• read
  Module supports input from a file.
• write
  Module support output to a file.
• category
  A category string to be used if the module is stored in a repository.
• classuuid
  The base class UUID of this module.
• comment
  A free-form comment.
• date
  The date the module source code was last changed.
• doi
  A digital object identifier for the module, if defined.
• email
  An email contact address of the developer of the module.
• features
  A list of the functions this module provide. Currently, these can be check (format auto-detection), read (format input) and write (format output).
• infourl
  A URL with information on the module, or an empty string if unset.
• keywords
  A list of keywords associated with the module.
• license
  The license class associated with this module. Setting the license to a standard type updates the associated URL with a standard location.
• licenseurl
  A URL with details about the module license.
• literature
  A free-form literature reference.
• mimetype
  The MIME type associated with the format.
• name
  The primary name of the format. Since the information may be queried via an alias name, this can be different from the command argument.
• orcid
  The ORCID code of the author (see www.orcid.org).
• path
  The repository path for displaying hierarchical repository trees. This attribute is independent of any file system paths.
• phone
  A contact phone number of the author.
• references
  Cross references of the module. This is a nested list of class UUID s and reference type tags.
• regid
  For officially registered modules, this is the assigned registration ID. Unregistered modules report zero.
• slot
  The slot in the handler table the module was loaded into.
• suffixes
  A list of file name suffixes commonly associated with the format.
• version
  Version information for the module. This is a string in a 1.2.3 (or shortened) style.
• versionuuid
  The UUID associated with this module version.

netx list

netx list ?pattern?

Netx.List(?pattern=?)

Return a list of all currently loaded network file modules, including those handled by built-in modules. If desired, the list can be filtered by a string pattern.

netx ref

Netx.Ref(networkformat)

Python -only method to get a reference of the module, which allows terser attribute retrieval commands and other operations.

netx subcommands

netx subcommands

dir(Netx)

Return a list of the currently implemented subcommands of the netx command.