brutils 2.4.0__tar.gz → 2.5.0__tar.gz

{brutils-2.4.0 → brutils-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: brutils
-Version: 2.4.0
+Version: 2.5.0
 Summary: Utils library for specific Brazilian businesses
 License: MIT
 License-File: LICENSE
@@ -24,7 +24,7 @@ Classifier: Topic :: Office/Business
 Classifier: Topic :: Software Development :: Internationalization
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: coverage (>=7.2.7,<8.0.0)
-Requires-Dist: holidays (>=0.58,<0.95)
+Requires-Dist: holidays (>=0.58,<0.99)
 Requires-Dist: num2words (==0.5.14)
 Project-URL: Repository, https://github.com/brazilian-utils/python
 Description-Content-Type: text/markdown
@@ -244,7 +244,8 @@ Exemplo:
 
 Verifica se os dígitos de verificação do CNPJ (Cadastro Nacional da Pessoa
 Jurídica) fornecido correspondem ao seu número base. A entrada deve ser uma
-string de dígitos com o comprimento apropriado. Esta função não verifica a
+string de 14 caracteres, permitindo dígitos e letras maiúsculas nas 12
+primeiras posições e dígitos nas 2 últimas. Esta função não verifica a
 existência do CNPJ; ela só valida o formato da string.
 
 Argumentos:
@@ -316,12 +317,16 @@ Exemplo:
 
 ### generate_cnpj
 
-Gera uma string de dígitos CNPJ válida aleatória. Um número de filial
-opcional pode ser fornecido; o padrão é 1.
+Gera uma string de CNPJ válida aleatória. Um número de filial opcional pode ser
+fornecido; o padrão é 1. Use `alphanumeric=True` para gerar um CNPJ cujas 12
+primeiras posições podem conter dígitos e letras maiúsculas.
 
 Argumentos:
 
-- branch (int): Um número de filial opcional a ser incluído no CNPJ.
+- branch (int | str): Um número de filial opcional a ser incluído no CNPJ.
+  Valores de filial alfanuméricos são aceitos apenas com
+  `alphanumeric=True`.
+- alphanumeric (bool): Define se o CNPJ gerado deve ser alfanumérico.
 
 Retorna:
 
@@ -335,6 +340,13 @@ Exemplo:
 '34665388000161'
 >>> generate_cnpj(1234)
 "01745284123455"
+>>> generate_cnpj(alphanumeric=True)
+"9359QAG9000184"
+>>> generate_cnpj(branch="AB12", alphanumeric=True)
+"BR2026UTAB1290"
+>>> generate_cnpj(branch="CD34", alphanumeric=True)
+# CNPJ inválido para exemplos de validação:
+"NX9K79E2CD3400"
 ```
 
 ## CEP

{brutils-2.4.0 → brutils-2.5.0}/README.md

@@ -213,7 +213,8 @@ Exemplo:
 
 Verifica se os dígitos de verificação do CNPJ (Cadastro Nacional da Pessoa
 Jurídica) fornecido correspondem ao seu número base. A entrada deve ser uma
-string de dígitos com o comprimento apropriado. Esta função não verifica a
+string de 14 caracteres, permitindo dígitos e letras maiúsculas nas 12
+primeiras posições e dígitos nas 2 últimas. Esta função não verifica a
 existência do CNPJ; ela só valida o formato da string.
 
 Argumentos:
@@ -285,12 +286,16 @@ Exemplo:
 
 ### generate_cnpj
 
-Gera uma string de dígitos CNPJ válida aleatória. Um número de filial
-opcional pode ser fornecido; o padrão é 1.
+Gera uma string de CNPJ válida aleatória. Um número de filial opcional pode ser
+fornecido; o padrão é 1. Use `alphanumeric=True` para gerar um CNPJ cujas 12
+primeiras posições podem conter dígitos e letras maiúsculas.
 
 Argumentos:
 
-- branch (int): Um número de filial opcional a ser incluído no CNPJ.
+- branch (int | str): Um número de filial opcional a ser incluído no CNPJ.
+  Valores de filial alfanuméricos são aceitos apenas com
+  `alphanumeric=True`.
+- alphanumeric (bool): Define se o CNPJ gerado deve ser alfanumérico.
 
 Retorna:
 
@@ -304,6 +309,13 @@ Exemplo:
 '34665388000161'
 >>> generate_cnpj(1234)
 "01745284123455"
+>>> generate_cnpj(alphanumeric=True)
+"9359QAG9000184"
+>>> generate_cnpj(branch="AB12", alphanumeric=True)
+"BR2026UTAB1290"
+>>> generate_cnpj(branch="CD34", alphanumeric=True)
+# CNPJ inválido para exemplos de validação:
+"NX9K79E2CD3400"
 ```
 
 ## CEP

{brutils-2.4.0 → brutils-2.5.0}/brutils/cnpj.py

@@ -1,5 +1,6 @@
 from itertools import chain
-from random import randint
+from random import choices, randint
+from string import ascii_uppercase, digits
 
 # FORMATTING
 ############
@@ -83,7 +84,12 @@ def display(cnpj: str) -> str | None:
        backward compatibility.
     """
 
-    if not cnpj.isdigit() or len(cnpj) != 14 or len(set(cnpj)) == 1:
+    if (
+        len(cnpj) != 14
+        or not _is_alphanumeric(cnpj[:12])
+        or not cnpj[12:].isdigit()
+        or len(set(cnpj)) == 1
+    ):
         return None
     return "{}.{}.{}/{}-{}".format(
         cnpj[:2], cnpj[2:5], cnpj[5:8], cnpj[8:12], cnpj[12:]
@@ -124,6 +130,27 @@ def format_cnpj(cnpj: str) -> str | None:
 ############
 
 
+def _is_alphanumeric(cnpj: str) -> bool:
+    """
+    Checks whether all characters are digits or uppercase letters.
+
+    Args:
+        cnpj (str): The CNPJ string to be validated.
+
+    Returns:
+        bool: True if all characters are either digits or uppercase letters,
+        False otherwise.
+
+    Example:
+        >>> _is_alphanumeric("035ABC1400Z142")
+        True
+        >>> _is_alphanumeric("0011-22200013!")
+        False
+    """
+
+    return all(char in (digits + ascii_uppercase) for char in cnpj)
+
+
 def validate(cnpj: str) -> bool:
     """
     Validates a CNPJ (Brazilian Company Registration Number) by comparing its
@@ -151,7 +178,12 @@ def validate(cnpj: str) -> bool:
        backward compatibility.
     """
 
-    if not cnpj.isdigit() or len(cnpj) != 14 or len(set(cnpj)) == 1:
+    if (
+        len(cnpj) != 14
+        or not _is_alphanumeric(cnpj[:12])
+        or not cnpj[12:].isdigit()
+        or len(set(cnpj)) == 1
+    ):
         return False
     return all(
         _hashdigit(cnpj, i + 13) == int(v) for i, v in enumerate(cnpj[12:])
@@ -183,13 +215,18 @@ def is_valid(cnpj: str) -> bool:
     return isinstance(cnpj, str) and validate(cnpj)
 
 
-def generate(branch: int = 1) -> str:
+def generate(branch: int | str = 1, alphanumeric: bool = False) -> str:
     """
-    Generates a random valid CNPJ digit string. An optional branch number
-    parameter can be given; it defaults to 1.
+    Generates a random valid CNPJ string. An optional branch number parameter
+    can be given; it defaults to 1. Use alphanumeric=True to generate a CNPJ
+    whose first 12 characters may contain digits and uppercase letters.
 
     Args:
-        branch (int): An optional branch number to be included in the CNPJ.
+        branch (int | str): An optional branch number to be included in the
+            CNPJ. Alphanumeric branch values are accepted only with
+            alphanumeric=True.
+        alphanumeric (bool): Whether the generated CNPJ should be
+            alphanumeric.
 
     Returns:
         str: A randomly generated valid CNPJ string.
@@ -199,8 +236,23 @@ def generate(branch: int = 1) -> str:
         "30180536000105"
         >>> generate(1234)
         "01745284123455"
+        >>> generate(branch="AB12", alphanumeric=True)
+        "NX9K79E2AB1200"
     """
 
+    if alphanumeric:
+        branch = str(branch)
+        branch = branch[:4] if len(branch) >= 4 else branch.zfill(4)
+        branch = (
+            "0001"
+            if branch == "0000" or not _is_alphanumeric(branch)
+            else branch
+        )
+        base = "".join(choices(digits * 3 + ascii_uppercase, k=8)) + branch
+
+        return base + _checksum(base)
+
+    branch = int(branch)
     branch %= 10000
     branch += int(branch == 0)
     branch = str(branch).zfill(4)
@@ -230,7 +282,10 @@ def _hashdigit(cnpj: str, position: int) -> int:
 
     weightgen = chain(range(position - 8, 1, -1), range(9, 1, -1))
     val = (
-        sum(int(digit) * weight for digit, weight in zip(cnpj, weightgen)) % 11
+        sum(
+            (ord(digit) - 48) * weight for digit, weight in zip(cnpj, weightgen)
+        )
+        % 11
     )
     return 0 if val < 2 else 11 - val
 

{brutils-2.4.0 → brutils-2.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "brutils"
-version = "2.4.0"
+version = "2.5.0"
 description = "Utils library for specific Brazilian businesses"
 authors = ["The Brazilian Utils Organization"]
 license = "MIT"
@@ -26,7 +26,7 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.10"
-holidays = ">=0.58,<0.95"
+holidays = ">=0.58,<0.99"
 num2words = "0.5.14"
 coverage = "^7.2.7"
 
@@ -34,7 +34,7 @@ coverage = "^7.2.7"
 coverage = "^7.2.7"
 
 [tool.poetry.group.dev.dependencies]
-ruff = "0.15.10"
+ruff = "0.15.17"
 
 [tool.ruff]
 line-length = 80