lsst.obs.base.gen2to3.repoWalker.parser.FormattableRegEx Class Reference

Inheritance diagram for lsst.obs.base.gen2to3.repoWalker.parser.FormattableRegEx:

Public Member Functions
re.Pattern	format (self, dict dataId)

Detailed Description

An interface that generates a regular expression from a template and
a data ID.

This is used by `PathElementParser` to abstract over whether a path
element's regex needs to include values from a data ID extracted from
parent path elements or not.

Definition at line 36 of file parser.py.

Member Function Documentation

format()

re.Pattern lsst.obs.base.gen2to3.repoWalker.parser.FormattableRegEx.format	(		self,
		dict	dataId
	)

Substitute values from the given data ID and return a regular
expression.

Parameters
----------
dataId : `dict`
    A dictionary whose entries may be used to format the regular
    expression.  May include unused entries.

Reimplemented in lsst.obs.base.gen2to3.repoWalker.parser.FixedRegEx.

Definition at line 46 of file parser.py.

    def format(self, dataId: dict) -> re.Pattern:
        """Substitute values from the given data ID and return a regular
        expression.
 
        Parameters
        ----------
        dataId : `dict`
            A dictionary whose entries may be used to format the regular
            expression.  May include unused entries.
        """
        raise NotImplementedError()
 
 

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/gen2to3/repoWalker/parser.py