├── .github └── workflows │ └── test.yaml ├── .gitignore ├── LICENSE.txt ├── README.md ├── brazilian_utils ├── __init__.py ├── cpf │ └── __init__.py └── tests │ ├── __init__.py │ └── test_cpf.py ├── constant.py └── setup.py /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: Run Tests 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | 8 | runs-on: ubuntu-latest 9 | strategy: 10 | matrix: 11 | python-version: [3.6, 3.7, 3.8, 3.9] 12 | 13 | steps: 14 | - uses: actions/checkout@v2 15 | - name: Set up Python ${{ matrix.python-version }} 16 | uses: actions/setup-python@v2 17 | with: 18 | python-version: ${{ matrix.python-version }} 19 | - name: Test 20 | run: | 21 | python -m unittest 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.gitignore.io/api/vim,python,pycharm 3 | 4 | ### PyCharm ### 5 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 6 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 7 | 8 | # User-specific stuff 9 | .idea/**/workspace.xml 10 | .idea/**/tasks.xml 11 | .idea/**/usage.statistics.xml 12 | .idea/**/dictionaries 13 | .idea/**/shelf 14 | .idea 15 | 16 | # Sensitive or high-churn files 17 | .idea/**/dataSources/ 18 | .idea/**/dataSources.ids 19 | .idea/**/dataSources.local.xml 20 | .idea/**/sqlDataSources.xml 21 | .idea/**/dynamic.xml 22 | .idea/**/uiDesigner.xml 23 | .idea/**/dbnavigator.xml 24 | 25 | # Gradle 26 | .idea/**/gradle.xml 27 | .idea/**/libraries 28 | 29 | # Gradle and Maven with auto-import 30 | # When using Gradle or Maven with auto-import, you should exclude module files, 31 | # since they will be recreated, and may cause churn. Uncomment if using 32 | # auto-import. 33 | # .idea/modules.xml 34 | # .idea/*.iml 35 | # .idea/modules 36 | 37 | # CMake 38 | cmake-build-*/ 39 | 40 | # Mongo Explorer plugin 41 | .idea/**/mongoSettings.xml 42 | 43 | # File-based project format 44 | *.iws 45 | 46 | # IntelliJ 47 | out/ 48 | 49 | # mpeltonen/sbt-idea plugin 50 | .idea_modules/ 51 | 52 | # JIRA plugin 53 | atlassian-ide-plugin.xml 54 | 55 | # Cursive Clojure plugin 56 | .idea/replstate.xml 57 | 58 | # Crashlytics plugin (for Android Studio and IntelliJ) 59 | com_crashlytics_export_strings.xml 60 | crashlytics.properties 61 | crashlytics-build.properties 62 | fabric.properties 63 | 64 | # Editor-based Rest Client 65 | .idea/httpRequests 66 | 67 | ### PyCharm Patch ### 68 | # Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721 69 | 70 | # *.iml 71 | # modules.xml 72 | # .idea/misc.xml 73 | # *.ipr 74 | 75 | # Sonarlint plugin 76 | .idea/sonarlint 77 | 78 | ### Python ### 79 | # Byte-compiled / optimized / DLL files 80 | __pycache__/ 81 | *.py[cod] 82 | *$py.class 83 | 84 | # C extensions 85 | *.so 86 | 87 | # Distribution / packaging 88 | .Python 89 | build/ 90 | develop-eggs/ 91 | dist/ 92 | downloads/ 93 | eggs/ 94 | .eggs/ 95 | lib/ 96 | lib64/ 97 | parts/ 98 | sdist/ 99 | var/ 100 | wheels/ 101 | *.egg-info/ 102 | .installed.cfg 103 | *.egg 104 | MANIFEST 105 | 106 | # PyInstaller 107 | # Usually these files are written by a python script from a template 108 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 109 | *.manifest 110 | *.spec 111 | 112 | # Installer logs 113 | pip-log.txt 114 | pip-delete-this-directory.txt 115 | 116 | # Unit test / coverage reports 117 | htmlcov/ 118 | .tox/ 119 | .coverage 120 | .coverage.* 121 | .cache 122 | nosetests.xml 123 | coverage.xml 124 | *.cover 125 | .hypothesis/ 126 | .pytest_cache/ 127 | 128 | # Translations 129 | *.mo 130 | *.pot 131 | 132 | # Django stuff: 133 | *.log 134 | local_settings.py 135 | db.sqlite3 136 | 137 | # Flask stuff: 138 | instance/ 139 | .webassets-cache 140 | 141 | # Scrapy stuff: 142 | .scrapy 143 | 144 | # Sphinx documentation 145 | docs/_build/ 146 | 147 | # PyBuilder 148 | target/ 149 | 150 | # Jupyter Notebook 151 | .ipynb_checkpoints 152 | 153 | # pyenv 154 | .python-version 155 | 156 | # celery beat schedule file 157 | celerybeat-schedule 158 | 159 | # SageMath parsed files 160 | *.sage.py 161 | 162 | # Environments 163 | .env 164 | .venv 165 | env/ 166 | venv/ 167 | ENV/ 168 | env.bak/ 169 | venv.bak/ 170 | 171 | # Spyder project settings 172 | .spyderproject 173 | .spyproject 174 | 175 | # Rope project settings 176 | .ropeproject 177 | 178 | # mkdocs documentation 179 | /site 180 | 181 | # mypy 182 | .mypy_cache/ 183 | 184 | ### Python Patch ### 185 | .venv/ 186 | 187 | ### Python.VirtualEnv Stack ### 188 | # Virtualenv 189 | # http://iamzed.com/2009/05/07/a-primer-on-virtualenv/ 190 | [Bb]in 191 | [Ii]nclude 192 | [Ll]ib 193 | [Ll]ib64 194 | [Ll]ocal 195 | [Ss]cripts 196 | pyvenv.cfg 197 | pip-selfcheck.json 198 | 199 | ### Vim ### 200 | # Swap 201 | [._]*.s[a-v][a-z] 202 | [._]*.sw[a-p] 203 | [._]s[a-rt-v][a-z] 204 | [._]ss[a-gi-z] 205 | [._]sw[a-p] 206 | 207 | # Session 208 | Session.vim 209 | 210 | # Temporary 211 | .netrwhist 212 | *~ 213 | # Auto-generated tag files 214 | tags 215 | # Persistent undo 216 | [._]*.un~ 217 | 218 | 219 | # End of https://www.gitignore.io/api/vim,python,pycharm 220 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2016 Alex Rocha 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/) 2 | 3 | # Deprecated 4 | 5 | This repository is no longer supported, please consider using 6 | [brutils-python][brutils-python] instead. 7 | 8 |
9 |

🇧🇷 Brazilian Utils

10 | 11 |

Utils library for Brazilian-specific businesses.

12 |
13 | 14 | # Getting Started 15 | 16 | Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business. 17 | 18 | ## Installation 19 | 20 | Using **Brazilian Utils** is quite simple and you can install it using [pip][pip-installation]: 21 | 22 | ```bash 23 | pip install brazilian-utils 24 | ``` 25 | 26 | ## Usage 27 | 28 | To use one of our utilities you just need to import the required function as in the example below: 29 | 30 | ```python 31 | from brazilian_utils import is_valid_cpf 32 | 33 | is_valid_cpf("1232454233345") # False 34 | ``` 35 | 36 | You can check the list containing all utilities [here][utilities]. 37 | 38 | [brutils-python]: https://github.com/brazilian-utils/brutils-python 39 | [pip-installation]: https://pip.pypa.io/en/stable/installing/ 40 | [utilities]: https://github.com/brazilian-utils/python/blob/master/brazilian_utils/__init__.py 41 | -------------------------------------------------------------------------------- /brazilian_utils/__init__.py: -------------------------------------------------------------------------------- 1 | from brazilian_utils.cpf import is_valid as is_valid_cpf 2 | -------------------------------------------------------------------------------- /brazilian_utils/cpf/__init__.py: -------------------------------------------------------------------------------- 1 | # This module provides a single method, is_valid(), 2 | # which returns True or False to indicate whether a given cpf 3 | # is valid according with Ministério da Fazenda specification. 4 | 5 | from constant import BLOCKLIST 6 | 7 | 8 | def is_valid(cpf): 9 | if not isinstance(cpf, str): 10 | return False 11 | 12 | if cpf in BLOCKLIST or not cpf.isdigit(): 13 | return False 14 | 15 | if len(cpf) != 11: 16 | return False 17 | 18 | first_digit = validate_first_digit(cpf) 19 | second_digit = validate_second_digit(cpf) 20 | 21 | verificators = cpf[-2:] 22 | 23 | return first_digit == int(verificators[0]) and second_digit == int(verificators[1]) 24 | 25 | 26 | def validate_first_digit(cpf): 27 | """Calculate first verificator digit""" 28 | weigth = list(range(10, 1, -1)) 29 | result = 11 - (sum(int(cpf[:9][g]) * weigth[g] for g in range(9)) % 11) 30 | return result if result <= 9 else 0 31 | 32 | 33 | def validate_second_digit(cpf): 34 | """Calculate second verificator digit""" 35 | weigth = list(range(11, 1, -1)) 36 | result = 11 - (sum(int(cpf[:10][g]) * weigth[g] for g in range(10)) % 11) 37 | return result if result <= 9 else 0 38 | -------------------------------------------------------------------------------- /brazilian_utils/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/brazilian-utils/python/92634f2ea00c98b4e4ccad5d3e00324a9e236246/brazilian_utils/tests/__init__.py -------------------------------------------------------------------------------- /brazilian_utils/tests/test_cpf.py: -------------------------------------------------------------------------------- 1 | from unittest import TestCase 2 | from brazilian_utils import cpf 3 | from constant import BLOCKLIST 4 | 5 | 6 | class TestCPF(TestCase): 7 | def test_cpf_in_blocklist(self): 8 | for c in BLOCKLIST: 9 | with self.subTest(): 10 | self.assertFalse(cpf.is_valid(c)) 11 | 12 | def test_is_digit(self): 13 | self.assertFalse(cpf.is_valid("ABC9123DF12312")) 14 | 15 | def test_is_empty_or_None(self): 16 | self.assertFalse(cpf.is_valid("")) 17 | self.assertFalse(cpf.is_valid(None)) 18 | 19 | def test_has_11_digits(self): 20 | self.assertFalse(cpf.is_valid("123")) 21 | self.assertFalse(cpf.is_valid("12345678901236")) 22 | 23 | def test_validate_first_digit(self): 24 | self.assertEqual(cpf.validate_first_digit("12345678901"), 0) 25 | self.assertEqual(cpf.validate_first_digit("52998224725"), 2) 26 | 27 | def test_validate_second_digit(self): 28 | self.assertEqual(cpf.validate_second_digit("12345678901"), 9) 29 | self.assertEqual(cpf.validate_second_digit("52998224725"), 5) 30 | 31 | def test_is_valid(self): 32 | self.assertTrue(cpf.is_valid("58756403240")) 33 | self.assertTrue(cpf.is_valid("71746540532")) 34 | self.assertFalse(cpf.is_valid("71746540531")) 35 | self.assertFalse(cpf.is_valid("58756403257")) 36 | -------------------------------------------------------------------------------- /constant.py: -------------------------------------------------------------------------------- 1 | BLOCKLIST = [ 2 | "00000000000", 3 | "11111111111", 4 | "22222222222", 5 | "33333333333", 6 | "44444444444", 7 | "55555555555", 8 | "66666666666", 9 | "77777777777", 10 | "88888888888", 11 | "99999999999", 12 | ] 13 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup( 4 | name='brazilian-utils', 5 | version='0.1.0', 6 | packages=['brazilian_utils'], 7 | url='https://github.com/brazilian-utils/python', 8 | license='MIT', 9 | author='Alex Rocha', 10 | author_email='alex.rochas@yahoo.com.br', 11 | description='Utils library for specific Brazilian businesses.' 12 | ) 13 | --------------------------------------------------------------------------------