Misc

Taxonomy

See also app.taxonomy_es

Fetching taxonomies files and representing them

See also app.taxonomy_es

class app.taxonomy.Taxonomy

A class representing a taxonomy.

For more information about taxonomy, see https://wiki.openfoodfacts.org/Global_taxonomies.

A Taxonomy instance has only a single nodes attribute, that maps the node identifier to a TaxonomyNode.

add(key: str, node: TaxonomyNode) → None

Add a node to the taxonomy under the id key.

Parameters:

• key – The node id

• node – the TaxonomyNode

find_deepest_nodes(nodes: List[TaxonomyNode]) → List[TaxonomyNode]

Given a list of nodes, returns the list of nodes where all the parents within the list have been removed.

For example, for a taxonomy, ‘fish’ -> ‘salmon’ -> ‘smoked-salmon’:

[‘fish’, ‘salmon’] -> [‘salmon’] [‘fish’, ‘smoked-salmon’] -> [smoked-salmon’]

classmethod from_dict(data: dict[str, Any]) → Taxonomy

Create a Taxonomy from data.

Parameters:

data – the taxonomy as a dict

Returns:

a Taxonomy

classmethod from_path(file_path: str | Path) → Taxonomy

Create a Taxonomy from a JSON file.

Parameters:

file_path – a JSON file, gzipped (.json.gz) files are supported

Returns:

a Taxonomy

classmethod from_url(url: str, session: Session | None = None, timeout: int = 120) → Taxonomy

Create a Taxonomy from a taxonomy file hosted at url.

Parameters:

• url – the URL of the taxonomy

• session – the requests session, use a default session if None

• timeout – the request timeout, defaults to 120

Returns:

a Taxonomy

get_localized_name(key: str, lang: str) → str | None

Return the name of a taxonomy element in a given language.

If key is not in the taxonomy or if no name is available for the requested language, return None.

Parameters:

• key – the taxonomy element id

• lang – the 2-letter language code

Returns:

the localized name or None

is_parent_of_any(item: str, candidates: Iterable[str], raises: bool = True) → bool

Return True if item is parent of any candidate, False otherwise.

If the item is not in the taxonomy and raises is False, return False.

Parameters:

• item – The item to compare

• candidates – A list of candidates

• raises – if True, raises a ValueError if item is not in the taxonomy, defaults to True.

iter_nodes() → Iterable[TaxonomyNode]

Iterate over the nodes of the taxonomy.

keys() → Iterable[str]

Return all node IDs from the taxonomy.

to_dict() → dict[str, Any]

Generate a dict from the Taxonomy.

class app.taxonomy.TaxonomyNode(identifier: str, names: Dict[str, str], synonyms: Dict[str, List[str]] | None, properties: Dict[str, Any] | None = None)

A taxonomy element.

Each node has 0+ parents and 0+ children. Each node has the following attributes:

• id: the node identifier, it starts with a language prefix (ex: en:)

• names: a dict mapping language 2-letter code to the node name for this language

• parents: the list of the node parents

• children: the list of the node children

• properties: additional properties of the node (taxonomy-dependent)

• synonyms: a dict mapping language 2-letter code to a list of synonyms for this language

get_localized_name(lang: str, add_xx: bool = False) → str | None

Return the localized name of the node.

We first check if there is an entry in names under the provided lang. Otherwise, we check the existence of an international name (xx) if add_xx=True. We return None if both checks failed.

Parameters:

lang – the language code

get_parents_hierarchy() → List[TaxonomyNode]

Return the list of all parent nodes (direct and indirect).

is_child_of(item: TaxonomyNode) → bool

Return True if item is a child of self in the taxonomy.

is_parent_of(candidate: TaxonomyNode) → bool

Return True if self is parent of candidate, False otherwise.

Parameters:

candidate – a TaxonomyNode of the same Taxonomy

is_parent_of_any(candidates: Iterable[TaxonomyNode]) → bool

Return True if self is a parent of any of candidates, False otherwise.

Parameters:

candidates – an iterable of TaxonomyNodes of the same Taxonomy

app.taxonomy.get_taxonomy(taxonomy_name: str, taxonomy_url: str, force_download: bool = False, download_newer: bool = False, cache_dir: Path | None = None) → Taxonomy

Return the taxonomy of the provided name.

The taxonomy file is downloaded and cached locally.

Parameters:

• taxonomy_name – the requested taxonomy name

• taxonomy_url – the URL of the taxonomy

• force_download – if True, (re)download the taxonomy even if it was cached, defaults to False

• download_newer – if True, download the taxonomy if a more recent version is available (based on file Etag)

• cache_dir – the cache directory to use, defaults to ~/.cache/openfoodfacts/taxonomy

Returns:

a Taxonomy

Health check

This module contains the health check functions for the application.

It is based upon the py-healthcheck library.

app.health.test_connect_es()

Test connection to ElasticSearch.

app.health.test_connect_redis()

Test connection to REDIS.