xbrl.oim.OIMCSVMetaData

class xbrl.oim.OIMCSVMetaData

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Class methods

classmethod xbrl.oim.OIMCSVMetaData.create_from_url(type cls, url, *, catalog=None, taxonomy_package=None, **kargs)

Returns a tuple with an xbrl.oim.OIMCSVMetaData and xml.ErrorLog object. Constructs a new xbrl.oim.OIMCSVMetaData object after parsing the JSON [metadata file] (https://www.xbrl.org/Specification/xbrl-csv/REC-2021-10-13+errata-2023-04-19/xbrl-csv-REC-2021-10-13+corrected-errata-2023-04-19.html#metadata-file) for xBRL-CSV content retrieved from the given url. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Any errors and warnings reported during the process can be accessed through the returned xml.ErrorLog object.

Attributes

xbrl.oim.OIMCSVMetaData.effective_metadata_json

Returns an xbrl.oim.OIMCSVMetaDataDocumentInfo object.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__