feat(Taxonomy): allow fetching taxonomies from other flavors (obf, opff, opf)

[raphodn]

Description

Similar to #223, extend the get_taxonomy logic to allow fetching taxonomies for non-off favors.

Solution

• Update the get_taxonomy() logic
  • new flavor param, defaults to off
• Update the TAXONOMY_URLS dict
  • add available obf, opff & opf taxonomies
  • fyi obf also as body_parts.full.json but this can be done in a another PR later

Related issue(s)

• Fixes Extend get_taxonomy to other flavors (obf, opf, opff) #465

[raphodn]

not necessarily needed, but avoid conflicts if the user has in its cache the same taxonomy from different flavors

[raphodn]

kinda frustrating that get_taxonomy() has type THEN flavor
whereas get_dataset() has flavor THEN type ^^

[Freso]

Maybe, though we’d want flavor to default to OFF anyway, so it was never going to be the first parameter, since we do not want to set a default taxonomy_type.

Also, when invoking the function, you can always invoke with keyword-only arguments, and then you get to decide the order yourself. ;)

[raphodn]

yes but

• the taxonomy_type does not have a default, so it has to be passed as an argument
• and in python you can't have defaulted parameters before non-defaulted ones
  so we're stuck ^^
• though you're saying that when invoking with parameters i can reorder them ? i need to try 👀

but in the end, re-reading this, well dataset_type & taxonomy_type are not really comparable in value, just that their name is similar haha

[Freso]

With all the changes here, and esp. with all the repetition, this might be better to make into a function? Maybe something like:

def get_taxonomy_url(taxonomy_type, flavor=off) -> str:
    if flavor = off:
        valid_taxonomies = (categories, …, other_nutritional_substances)
        # these sets of valid taxonomies should maybe be
        # new globals in place of TAXONOMY_URLS, in case
        # other code wants to reference it?
    elif flavor = obf:
        valid_taxonomies = (categories, …, allergens)
    elif …:
        …
    else:
        # Unrecognised flavor
        raise UnrecognisedFlavorError
        # or return None?
    if taxonomy_type in valid_taxonomies:
        return URLBuilder.static(flavor, Environment.org)
            + f"/data/taxonomies/{taxonomy_type}.full.json",
    else:
        raise UnknownTaxonomyTypeError
        # or return None?

Or subclass URLBuilder into a TaxonomyURLBuilder class, overriding the static() method to take flavor, taxonomy_type?

[Freso]

Maybe, though we’d want flavor to default to OFF anyway, so it was never going to be the first parameter, since we do not want to set a default taxonomy_type.

Also, when invoking the function, you can always invoke with keyword-only arguments, and then you get to decide the order yourself. ;)

[sonarqubecloud]

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[raphael0202]

As @Freso was suggesting, I also think it would be worth creating a get_taxonomy_url function that would take as argument the flavor and the filename, to shorten a bit this dict.

[raphodn]

I'll do this in a followup PR 👍

[raphodn]

done in #475