Module common

replaces @<identifier> with <dictName>["<identifier>"] in src.

We do this to support this shortcut in the vicinity of rowmakers (i.e., there and in procApps).

returns the element for the DaCHS reference ``refString``.

``refString`` has the form ``rdId[#subRef]``; ``rdId`` can be filesystem-relative, but the RD referenced must be below ``inputsDir`` anyway.

You can pass a structure class into ``forceType``, and a ``StructureError`` will be raised if what's pointed to by the id isn't of that type.

You should usually use ``base.resolveCrossId`` instead of this from *within* DaCHS. This is intended for code handling RD ids from users.

This supports further keyword arguments to getRD.

returns the standard DaCHS PubDID for ``path``.

The publisher dataset identifier (PubDID) is important in protocols like SSAP and obscore. If you use this function, the PubDID will be your authority, the path compontent ~, and the inputs-relative path of the input file as the parameter.

``path`` can be relative, in which case it is interpreted relative to the DaCHS ``inputsDir.``

You *can* define your PubDIDs in a different way, but you'd then need to provide a custom descriptorGenerator to datalink services (and might need other tricks). If your data comes from plain files, use this function.

In a rowmaker, you'll usually use the \standardPubDID macro.

Decorators:

• @utils.document

returns a datalink URL for the product referenced through accref with the datalink service dlSvc.

This assumes that dlSvc uses the standard DaCHS pubDIDs. dlSvc needs to be the service element.

A typical use is in a metaMaker and would look like this:

       getDatalinkMetaLink(rd.getById("dl"), descriptor.accref)

Decorators:

• @utils.document

returns an accref from a standard DaCHS PubDID.

This is basically the inverse of getStandardPubDID. It will raise NotFound if pubdid "looks like a URI" (implementation detail: has a colon in the first 10 characters) and does not start with ivo://<authority>/~?. If it's not a URI, we assume it's a local accref and just return it.

The function does not check if the remaining characters are a valid accref, much less whether it can be resolved.

authBase's default will reflect you system's settings on your installation, which probably is not what's given in this documentation.

Decorators:

• @utils.document

returns absath relative to the DaCHS inputsDir.

If ``absPath`` is not below ``inputsDir``, a ``ValueError`` results. On ``liberalChars``, wee see the `function getRelativePath`_.

In rowmakers and rowfilters, you'll usually use the macro ``\inputRelativePath`` that inserts the appropriate code.

Decorators:

• @utils.document