Skip to content

Bug/fix pattern encoding for SIRENE search #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tfardet merged 3 commits into from
Dec 15, 2025
Merged

Bug/fix pattern encoding for SIRENE search #288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e21c77a
safe encoding
tgrandje Dec 11, 2025
2fb71d3
Fix ref in docstring
tgrandje Dec 15, 2025
6e383c6
Fix punctuation pattern
tgrandje Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 82 additions & 1 deletion pynsee/sirene/search_sirene.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,55 @@

from functools import lru_cache
import itertools
import logging
import re
import string
import urllib.parse

from unidecode import unidecode

from pynsee.utils.save_df import save_df
from ._clean_data import _clean_data
from ._request_sirene import _request_sirene
from .sirenedataframe import SireneDataFrame

import logging

logger = logging.getLogger(__name__)

SEPARATORS = {
# See doc : https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=66396595-39c0-44b2-b965-9539c004b244#variables-%C3%A9tablissement
"enseigne1Etablissement": " -'*/()",
"enseigne2Etablissement": " -'*/()",
"enseigne3Etablissement": " -'*/()",
"denominationUsuelleEtablissement": " -'*/()",
"libelleVoieEtablissement": " -?'*/:!()[]",
"libelleCommuneEtablissement": " -?'*/:!()[]",
"libelleCommuneEtrangerEtablissement": " -?'*/:!()[]",
"distributionSpecialeEtablissement": " -?'*/:!()[]",
"libellePaysEtrangerEtablissement": " -?'*/:!()[]",
"libelleCedexEtablissement": " -?'*/:!()[]",
"nomUsageUniteLegale": " -?'/",
"prenom1UniteLegale": " -?'/",
"prenom2UniteLegale": " -?'/",
"prenom3UniteLegale": " -?'/",
"prenom4UniteLegale": " -?'/",
"prenomUsuelUniteLegale": " -?'/",
"nomUniteLegale": " -?'/",
"denominationUniteLegale": " -?'/",
"pseudonymeUniteLegale": " -?'/",
"libelleNationaliteUniteLegale": " -?'/",
"denominationUsuelle1UniteLegale": " -?'/",
"denominationUsuelle2UniteLegale": " -?'/",
"denominationUsuelle3UniteLegale": " -?'/",
"sigleUniteLegale": " .-?'/",
"complementAdresseEtablissement": " ?'*/:!()[]",
"typeVoieEtablissement": " ?'*/:!()[]",
# Note : for the following fields, the "punctuation+blanc*" rule is managed
# directly in the code, see "safe_encode" func
"numeroVoieEtablissement": " ",
"dernierNumeroVoieEtablissement": " ",
}


@lru_cache(maxsize=None)
def _warning_search_sirene():
Expand All @@ -32,6 +69,46 @@ def _warning_data_save():
)


def safe_encode(field: str, val: str) -> str:
"""
Encode any special characters in a pattern, except for characters
mentionned as separators in the API's doc.

See doc : https://portail-api.insee.fr/catalog/api/2ba0e549-5587-3ef1-9082-99cd865de66f/doc?page=66396595-39c0-44b2-b965-9539c004b244#variables-%C3%A9tablissement

Parameters
----------
field : str
Target field of the query (ex. 'denominationUniteLegale').
val : str
Subquery targetting this field (ex. "ART & CLIM SARL")

Returns
-------
str
Cleaned val.

Example
-------
safe_encode("denominationUniteLegale", "ART & CLIM SARL")
>>> 'ART %26 CLIM SARL'

"""
if field in {
"numeroVoieEtablissement",
"dernierNumeroVoieEtablissement",
}:
# "ponctuation+blanc*" rule -> replace by single whitespace which
# will be preserved anyway (and then used by the API to split
# the query)
safe = "( |([" + string.punctuation + "] +))"
val = re.sub(safe, " ", val)
try:
return urllib.parse.quote(val, safe=SEPARATORS[field])
except KeyError:
return val


@save_df(day_lapse_max=30, cls=SireneDataFrame)
def search_sirene(
variable,
Expand Down Expand Up @@ -161,6 +238,10 @@ def search_sirene(
if isinstance(pattern, str):
pattern = [pattern]

pattern = [
safe_encode(field, val) for field, val in zip(variable, pattern)
]

list_siren_hist_variable = [
"nomUniteLegale", #
"nomUsageUniteLegale", #
Expand Down