File: rcs.py

package info (click to toggle)
python-stdnum 2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,960 kB
  • sloc: python: 10,600; javascript: 6,995; sh: 13; makefile: 10
file content (117 lines) | stat: -rw-r--r-- 3,563 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# rcs.py - functions for handling French NIR numbers
# coding: utf-8
#
# Copyright (C) 2025 Fabien Michel
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA

"""RCS (French trade registration number for commercial companies).

The RCS number (Registre du commerce et des sociétés) is given by INSEE to a
company with commercial activity when created. It is required for most of
administrative procedures.

The number consists of "RCS" letters followed by name of the city where the company was registered
followed by letter A for a retailer or B for society
followed by the SIREN number

More information:

* https://entreprendre.service-public.fr/vosdroits/F31190
* https://fr.wikipedia.org/wiki/Registre_du_commerce_et_des_sociétés_(France)

>>> validate('RCS Nancy B 323 159 715')
'RCS Nancy B 323159715'
>>> validate('RCS Nancy B 323 159 716')
Traceback (most recent call last):
    ...
InvalidChecksum: ...
>>> validate('RCSNancy B 323 159 716')
Traceback (most recent call last):
    ...
InvalidFormat: ...
>>> format('RCS Nancy B323159715')
'RCS Nancy B 323 159 715'
>>> to_siren('RCS Nancy B 323159 715')
'323159715'
"""

from __future__ import annotations

import re

from stdnum.exceptions import *
from stdnum.fr import siren
from stdnum.util import clean


_rcs_validation_regex = re.compile(
    r'^ *(?P<tag>RCS|rcs) +(?P<city>.*?) +(?P<letter>[AB]) *(?P<siren>(?:\d *){9})\b *$',
)


def compact(number: str) -> str:
    """Convert the number to the minimal representation."""
    parts = clean(number).strip().split()
    rest = ''.join(parts[2:])
    return ' '.join(parts[:2] + [rest[:1], siren.compact(rest[1:])])


def validate(number: str) -> str:
    """Validate number is a valid French RCS number."""
    number = compact(number)
    match = _rcs_validation_regex.match(number)
    if not match:
        raise InvalidFormat()
    siren_number = siren.validate(match.group('siren'))
    siren_number = siren.format(siren_number)
    return number


def is_valid(number: str) -> bool:
    """Check if the number provided is valid."""
    try:
        return bool(validate(number))
    except ValidationError:
        return False


def format(number: str) -> str:
    """Reformat the number to the standard presentation format."""
    number = compact(number)
    match = _rcs_validation_regex.match(number)
    if not match:
        raise InvalidFormat()
    return ' '.join(
        (
            'RCS',
            match.group('city'),
            match.group('letter'),
            siren.format(match.group('siren')),
        ),
    )


def to_siren(number: str) -> str:
    """Extract SIREN number from the RCS number.

    The SIREN number is the 9 last digits of the RCS number.
    """
    number = compact(number)
    match = _rcs_validation_regex.match(clean(number))
    if not match:
        raise InvalidFormat()
    return match.group('siren')