arelle.utils.validate.ESEFImage

See COPYRIGHT.md for copyright information.

Module Contents

Classes

ImageValidationParameters

Functions

validateImageAndLog
iterCssUrls	Extracts and yields URLs from a collection of CSS tokens.
validateImage	image: either an url or base64 in data:image style
checkImageContents
checkSVGContent
getHref
checkSVGContentElt

API

class arelle.utils.validate.ESEFImage.ImageValidationParameters

checkMinExternalResourceSize: bool

None

consolidated: bool

None

contentOtherThanXHTMLGuidance: str

None

missingMimeTypeIsIncorrect: bool

None

recommendBase64EncodingEmbeddedImages: bool

None

supportedImgTypes: dict[bool, tuple[str, ...]]

None

classmethod from_non_esef(checkMinExternalResourceSize: bool, missingMimeTypeIsIncorrect: bool, recommendBase64EncodingEmbeddedImages: bool, supportedImgTypes: dict[bool, tuple[str, ...]]) → arelle.utils.validate.ESEFImage.ImageValidationParameters

arelle.utils.validate.ESEFImage.validateImageAndLog(baseUrl: str | None, image: str, modelXbrl: arelle.ModelXbrl.ModelXbrl, val: arelle.ValidateXbrl.ValidateXbrl, elts: lxml.etree._Element | list[lxml.etree._Element], evaluatedMsg: str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, prelude: list[Any] | None = None) → None

arelle.utils.validate.ESEFImage.iterCssUrls(tokens: collections.abc.Iterable[Any]) → collections.abc.Iterable[str]

Extracts and yields URLs from a collection of CSS tokens.

This function processes a sequence of CSS tokens to extract URLs that are defined within url() functions or as direct URL values. It handles nested structures by recursively parsing child tokens or arguments if available.

Args: tokens: An iterable sequence of CSS tokens, which may include URL tokens, function blocks, or other token types.

Yields: Extracted URL strings from the provided CSS tokens.

arelle.utils.validate.ESEFImage.validateImage(baseUrl: str | None, image: str, modelXbrl: arelle.ModelXbrl.ModelXbrl, val: arelle.ValidateXbrl.ValidateXbrl, elts: lxml.etree._Element | list[lxml.etree._Element], evaluatedMsg: str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters) → collections.abc.Iterable[arelle.utils.validate.Validation.Validation]

image: either an url or base64 in data:image style

arelle.utils.validate.ESEFImage.checkImageContents(baseURI: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], imgType: str, isFile: bool, data: bytes | str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, hasMimeType: bool, val: arelle.ValidateXbrl.ValidateXbrl) → collections.abc.Iterable[arelle.utils.validate.Validation.Validation]

arelle.utils.validate.ESEFImage.checkSVGContent(baseURI: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], data: bytes | str, params: arelle.utils.validate.ESEFImage.ImageValidationParameters, val: arelle.ValidateXbrl.ValidateXbrl) → collections.abc.Iterable[arelle.utils.validate.Validation.Validation]

arelle.utils.validate.ESEFImage.getHref(elt: lxml.etree._Element) → str

arelle.utils.validate.ESEFImage.checkSVGContentElt(elt: lxml.etree._Element, baseUrl: str | None, modelXbrl: arelle.ModelXbrl.ModelXbrl, imgElts: list[lxml.etree._Element], params: arelle.utils.validate.ESEFImage.ImageValidationParameters, val: arelle.ValidateXbrl.ValidateXbrl) → collections.abc.Iterable[arelle.utils.validate.Validation.Validation]