├── .gitattributes ├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.rst ├── conftest.py ├── requirements.txt ├── setup.cfg ├── setup.py ├── tests ├── __init__.py ├── app │ ├── __init__.py │ ├── urls.py │ └── views.py └── test_middleware.py ├── tox.ini ├── versioneer.py └── xff ├── __init__.py ├── _version.py └── middleware.py /.gitattributes: -------------------------------------------------------------------------------- 1 | xff/_version.py export-subst 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/* 2 | dist/* 3 | htmlcov/* 4 | __pycache__/* 5 | .ropeproject/* 6 | *.pyc 7 | *.swp 8 | *.egg-info 9 | db.sqlite3 10 | .cache 11 | .coverage 12 | .tox 13 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | 3 | sudo: false 4 | 5 | python: 6 | - "3.9" 7 | - "3.10" 8 | - "3.11" 9 | - "3.12" 10 | - "3.13" 11 | 12 | env: 13 | - DJANGO=4.2 14 | - DJANGO=5.0 15 | - DJANGO=5.1 16 | - DJANGO=master 17 | 18 | matrix: 19 | exclude: 20 | - python: "3.9" 21 | env: DJANGO=5.0 22 | - python: "3.9" 23 | env: DJANGO=5.1 24 | - python: "3.9" 25 | env: DJANGO=master 26 | include: 27 | - python: "3.13" 28 | env: TOXENV=flake8 29 | allow_failures: 30 | - env: DJANGO=master 31 | 32 | install: 33 | - pip install tox-travis coveralls 34 | 35 | script: 36 | - tox 37 | 38 | after_success: 39 | - coveralls 40 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015 Codetry Ltd 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 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.rst 3 | include versioneer.py 4 | include xff/_version.py 5 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | Django X-Forwarded-For Properly 2 | ------------------------------- 3 | 4 | .. image:: https://travis-ci.org/ferrix/xff.svg?branch=master 5 | :target: https://travis-ci.org/ferrix/xff 6 | .. image:: https://coveralls.io/repos/github/ferrix/xff/badge.svg 7 | :target: https://coveralls.io/github/ferrix/xff 8 | 9 | 10 | The X-Forwarded-For header is used by many reverse proxies to pass the 11 | IP addresses of the whole chain of hosts between client and application 12 | server. The header looks something like this:: 13 | 14 | X-Forwarded-For: 54.12.13.14, 192.168.2.0, 192.168.3.1 15 | 16 | This translates to:: 17 | 18 | X-Forwarded-For: client, proxy1[, proxy2[...]] 19 | 20 | However it is just a header. Most default configurations simply append 21 | to the header. It is trivial for a malicious client to deliver a header 22 | in the initial request:: 23 | 24 | X-Forwarded-For: phony, client 25 | 26 | What ``django-xff`` does 27 | ======================== 28 | 29 | This library provides a decent and configurable middleware to rewrite 30 | the ``request.META['REMOTE_ADDR']`` to the correct client IP. 31 | 32 | This is done by setting a depth of reverse proxies to be trusted alone. 33 | The ``X-Forwarded-For`` header will additionally be sanitized from any 34 | extraneous entries. 35 | 36 | By default, if the expected depth of proxies is 3, the ``client`` 37 | address will be used in all of these examples:: 38 | 39 | X-Forwarded-For: phony, client, proxy1, proxy2 40 | X-Forwarded-For: client, proxy1, proxy2 41 | X-Forwarded-For: client, proxy 42 | 43 | Note: 44 | 45 | * Less proxies than expected is allowed by default, for varying lengths 46 | of proxy chains, the longest is the only one that can be trusted. 47 | * No header set is allowed by default and the library does nothing. 48 | 49 | What ``django-xff`` does not do 50 | =============================== 51 | 52 | This library does not check the IP addresses of any proxies along the 53 | path of the message. 54 | 55 | This library is unable to detect compromised proxies or any incoming 56 | requests that have the right number addresses in the correct header. 57 | 58 | TODO 59 | ==== 60 | 61 | * Separate middleware that checks CIDR for the trusted proxies 62 | * Separate middleware that checks exact IP addresses for proxies 63 | 64 | Configuration 65 | ============= 66 | 67 | Add the following to your Django ``settings.py`` module to enable this 68 | middleware for two reverse proxies expected. The middlewares are 69 | processed order of appearance. This middleware should go somewhere 70 | near the top to avoid giving a potentially malicious user chances to 71 | validate passwords with malformed requests:: 72 | 73 | MIDDLEWARE_CLASSES = [ 74 | 75 | 'xff.middleware.XForwardedForMiddleware', 76 | 77 | ] 78 | 79 | XFF_TRUSTED_PROXY_DEPTH = 2 80 | 81 | By default, no attempts are denied. There are several settings to send 82 | a ``400`` (Bad Request) response to failing requests. Strict mode will 83 | stop all failing requests:: 84 | 85 | XFF_STRICT = True 86 | 87 | To prevent only the clearly malicious requests, use the following 88 | instead:: 89 | 90 | XFF_NO_SPOOFING = True 91 | 92 | To prevent requests that do not come through enough proxies, use the 93 | following:: 94 | 95 | XFF_ALWAYS_PROXY = True 96 | 97 | The previous setting implies a Bad Request when there is no 98 | ``X-Forwarded-For`` header present. The following setting follows the 99 | ``XFF_ALWAYS_PROXY`` and ``XFF_STRICT`` by default but can be set 100 | independently:: 101 | 102 | XFF_HEADER_REQUIRED = False 103 | 104 | Even in ``XFF_LOOSE_UNSAFE`` mode this will require the header:: 105 | 106 | XFF_LOOSE_UNSAFE = True 107 | 108 | For an unsafe setting, in development possibly, you can trust that the 109 | first entry is always correct and still get the assumed client IP in 110 | the right place, use:: 111 | 112 | XFF_LOOSE_UNSAFE = True 113 | 114 | By default, this middleware rewrites ``REMOTE_ADDR``. To leave it 115 | untouched, use:: 116 | 117 | XFF_REWRITE_REMOTE_ADDR = False 118 | 119 | If you want to keep the ``X-Forwarded-For`` header untouched even if 120 | there are extra entries, use:: 121 | 122 | XFF_CLEAN = False 123 | 124 | Whitelisting 125 | ============ 126 | 127 | In some cases requests from alternate request paths are to be expected. 128 | The Amazon Elastic Loadbalancer healthcheck or other administrative 129 | tasks need to be available even if they do not match the criteria. 130 | 131 | This library accepts URIs as regular expressions to be exempt for 132 | checking. These will be exempt for any validation including 133 | ``XFF_STRICT`` and ``XFF_HEADER_REQUIRED``. 134 | 135 | To define the whitelist:: 136 | 137 | XFF_EXEMPT_URLS = [ 138 | r'^healthcheck/$', 139 | r'^admin/', 140 | ] 141 | 142 | This will allow calling ``/healthcheck/`` and ``/admin/*`` from anywhere. 143 | It is a daft idea to allow everyone to access the admin site with less 144 | requirements than the other parts of the site. For this reason it is 145 | possible to respond with ``404`` (Not Found) when the request arrives 146 | through the main entrance:: 147 | 148 | XFF_EXEMPT_STEALTH = True 149 | 150 | This will assume that anything below ``XFF_TRUSTED_PROXY_DEPTH`` is 151 | trusted. The method is naive, but effective. 152 | 153 | Logging 154 | ======= 155 | 156 | Dropped requests will be logged. This means that there will be plenty of 157 | logs when the library is misconfigured or malicious things are taking 158 | place. It is recommended to keep the logs for tracing in case of a real 159 | attack. However they can be filtered from development by setting:: 160 | 161 | LOGGING = { 162 | 'loggers': { 163 | 'xff.middleware': { 164 | 'handlers': ['null'], 165 | 'propagate': False, 166 | }, 167 | }, 168 | } 169 | 170 | Setting up 171 | ========== 172 | 173 | It is recommended to enable the middleware with the assumed number of 174 | proxies and investigating the logs. If the header is not present or the 175 | middleware is not configured, there will be no log entries. If the logs 176 | state that the depth is incorrect, it should be reduced. If all 177 | requests are considered as spoofing, the depth should probably be 178 | increased:: 179 | 180 | MIDDLEWARE_CLASSES = [ 181 | 'xff.middleware.XForwardedForMiddleware', 182 | 'django.contrib.sessions.middleware.SessionMiddleware', 183 | 'django.middleware.common.CommonMiddleware', 184 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 185 | ] 186 | 187 | XFF_TRUSTED_PROXY_DEPTH = 2 188 | 189 | When logs appear correct, control can be increased in increments:: 190 | 191 | XFF_NO_SPOOFING = True 192 | 193 | Then:: 194 | 195 | XFF_STRICT = True 196 | 197 | Defining exceptions is feasible with other flags set. The following 198 | could be used behind an AWS Elastic Loadbalancer to prevent entry 199 | without the proper header set but allow healthcheck to return 200 | correctly. The stealth would also mask the same URI with a 404 201 | error:: 202 | 203 | XFF_TRUSTED_PROXY_DEPTH = 1 204 | XFF_EXEMPT_URLS = [r'^health/] 205 | XFF_REQUIRE_HEADER = True 206 | XFF_EXEMPT_STEALTH = True 207 | 208 | In case there is a chain of reverse proxies, the healthcheck URI is 209 | available for all layers except the last one. 210 | -------------------------------------------------------------------------------- /conftest.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | 3 | 4 | def pytest_configure(): 5 | import sys 6 | 7 | try: 8 | import django # NOQA 9 | except ImportError: 10 | print("Error: django not installed") 11 | sys.exit(1) 12 | 13 | settings.configure( 14 | INSTALLED_APPS=[ 15 | 'django.contrib.auth', 16 | 'django.contrib.contenttypes', 17 | 'django.contrib.admin', 18 | 'django.contrib.sessions', 19 | 'django.contrib.messages', 20 | 'django.contrib.staticfiles', 21 | 'tests.app', 22 | 'xff', 23 | ], 24 | MIDDLEWARE_CLASSES=( 25 | 'xff.middleware.XForwardedForMiddleware', 26 | 'django.contrib.sessions.middleware.SessionMiddleware', 27 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 28 | 'django.contrib.messages.middleware.MessageMiddleware', 29 | ), 30 | MIDDLEWARE=( 31 | 'xff.middleware.XForwardedForMiddleware', 32 | 'django.contrib.sessions.middleware.SessionMiddleware', 33 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 34 | 'django.contrib.messages.middleware.MessageMiddleware', 35 | ), 36 | DATABASES={ 37 | 'default': { 38 | 'ENGINE': 'django.db.backends.sqlite3', 39 | 'NAME': ':memory:', 40 | } 41 | }, 42 | ROOT_URLCONF='tests.app.urls', 43 | DEBUG=True, 44 | TEMPLATE_DEBUG=True, 45 | LOGGING={}, 46 | XFF_EXEMPT_URLS=[r'^health/$'], 47 | SECRET_KEY="secret" 48 | ) 49 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Django>=4.2 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | 2 | # See the docstring in versioneer.py for instructions. Note that you must 3 | # re-run 'versioneer.py setup' after changing this section, and commit the 4 | # resulting files. 5 | 6 | [versioneer] 7 | VCS = git 8 | style = pep440 9 | versionfile_source = xff/_version.py 10 | versionfile_build = 11 | tag_prefix = 12 | parentdir_prefix = xff- 13 | 14 | [bdist_wheel] 15 | universal = 1 16 | 17 | [tool:pytest] 18 | norecursedirs = .tox .eggs django_xff.egg-info build dist __pycache__ 19 | 20 | [coverage:run] 21 | omit = */_version.py 22 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import os 4 | import versioneer 5 | from setuptools import setup 6 | 7 | 8 | def parse_requirements(filename): 9 | lineiter = (line.strip() for line in open(filename)) 10 | return [line for line in lineiter if line and not line.startswith("#")] 11 | 12 | def get_requirements(filename): 13 | if not os.path.exists(filename): 14 | return [] 15 | 16 | return parse_requirements(filename) 17 | 18 | with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme: 19 | README = readme.read() 20 | 21 | setup(name='django-xff', 22 | version=versioneer.get_version(), 23 | cmdclass=versioneer.get_cmdclass(), 24 | description='Django X-Forwarded-For Properly', 25 | long_description=README, 26 | author='Ferrix Hovi', 27 | author_email='ferrix@codetry.fi', 28 | install_requires=get_requirements('requirements.txt'), 29 | packages=['xff'], 30 | url='https://github.com/ferrix/xff/', 31 | license='MIT License', 32 | classifiers=[ 33 | 'Environment :: Web Environment', 34 | 'Framework :: Django', 35 | 'Framework :: Django :: 4.2', 36 | 'Framework :: Django :: 5.0', 37 | 'Framework :: Django :: 5.1', 38 | 'Intended Audience :: Developers', 39 | 'Operating System :: OS Independent', 40 | 'Programming Language :: Python', 41 | 'License :: OSI Approved :: MIT License', 42 | 'Topic :: Internet :: WWW/HTTP', 43 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 44 | ], 45 | ) 46 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ferrix/xff/df194b221e7f9f4b6f748e437be084ef4e41dc83/tests/__init__.py -------------------------------------------------------------------------------- /tests/app/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ferrix/xff/df194b221e7f9f4b6f748e437be084ef4e41dc83/tests/app/__init__.py -------------------------------------------------------------------------------- /tests/app/urls.py: -------------------------------------------------------------------------------- 1 | """xfftest URL Configuration 2 | 3 | The `urlpatterns` list routes URLs to views. For more information please see: 4 | https://docs.djangoproject.com/en/1.8/topics/http/urls/ 5 | Examples: 6 | Function views 7 | 1. Add an import: from my_app import views 8 | 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') 9 | Class-based views 10 | 1. Add an import: from other_app.views import Home 11 | 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') 12 | Including another URLconf 13 | 1. Add an import: from blog import urls as blog_urls 14 | 2. Add a URL to urlpatterns: url(r'^blog/', include(blog_urls)) 15 | """ 16 | from django.urls import re_path 17 | from django.contrib import admin 18 | 19 | from tests.app.views import index 20 | 21 | urlpatterns = [ 22 | re_path(r'^admin/', admin.site.urls), 23 | re_path(r'^health/$', index), 24 | re_path('^$', index), 25 | ] 26 | -------------------------------------------------------------------------------- /tests/app/views.py: -------------------------------------------------------------------------------- 1 | from django.http import HttpResponse 2 | 3 | 4 | def index(request): 5 | return HttpResponse('OK') 6 | -------------------------------------------------------------------------------- /tests/test_middleware.py: -------------------------------------------------------------------------------- 1 | from unittest.mock import patch 2 | from django.test import TestCase, Client 3 | from django.test.utils import override_settings 4 | from xff.middleware import XForwardedForMiddleware 5 | 6 | 7 | class WebTestCase(TestCase): 8 | ''' Helpers for web request testing ''' 9 | def assert_http_ok(self, response, message=None): 10 | ''' Assert response code 200 ''' 11 | self.assertEqual(200, response.status_code, message) 12 | 13 | def assert_http_bad_request(self, response, message=None): 14 | ''' Assert response code 400 ''' 15 | self.assertEqual(400, response.status_code, message) 16 | 17 | 18 | class TestStrict(WebTestCase): 19 | def setUp(self): 20 | self.middleware = XForwardedForMiddleware() 21 | self.client = Client() 22 | self.patcher = patch('xff.middleware.logger', autospec=True) 23 | self.logger = self.patcher.start() 24 | 25 | def tearDown(self): 26 | self.patcher.stop() 27 | 28 | @override_settings(XFF_STRICT=True) 29 | def test_no_header(self): 30 | response = self.client.get('/') 31 | self.assert_http_bad_request(response) 32 | self.assertEqual(1, self.logger.error.call_count) 33 | 34 | @override_settings(XFF_STRICT=True) 35 | def test_no_header_exempt(self): 36 | response = self.client.get('/health/') 37 | self.assert_http_ok(response) 38 | assert not self.logger.method_calls 39 | 40 | @override_settings(XFF_STRICT=True, XFF_HEADER_REQUIRED=False) 41 | def test_no_header_not_required(self): 42 | response = self.client.get('/') 43 | self.assert_http_ok(response) 44 | assert not self.logger.method_calls 45 | 46 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_HEADER_REQUIRED=False) 47 | def test_no_header_not_required_exempt(self): 48 | response = self.client.get('/health/') 49 | self.assert_http_ok(response) 50 | assert not self.logger.method_calls 51 | 52 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 53 | XFF_HEADER_REQUIRED=False) 54 | def test_too_few_proxies(self): 55 | response = self.client.get('/', HTTP_X_FORWARDED_FOR='127.0.0.1') 56 | self.assert_http_bad_request(response) 57 | self.assertEqual(1, self.logger.warning.call_count) 58 | 59 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 60 | XFF_HEADER_REQUIRED=False) 61 | def test_too_few_proxies_exempt(self): 62 | response = self.client.get('/health/', 63 | HTTP_X_FORWARDED_FOR='127.0.0.1') 64 | self.assert_http_ok(response) 65 | assert not self.logger.method_calls 66 | 67 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 68 | XFF_HEADER_REQUIRED=False) 69 | def test_correct_proxies(self): 70 | response = self.client.get( 71 | '/', 72 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2') 73 | self.assert_http_ok(response) 74 | assert not self.logger.method_calls 75 | 76 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 77 | XFF_HEADER_REQUIRED=False, XFF_EXEMPT_STEALTH=True) 78 | def test_correct_proxies_exempt_stealth(self): 79 | response = self.client.get( 80 | '/health/', 81 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2') 82 | self.assertEqual(404, response.status_code) 83 | assert not self.logger.method_calls 84 | 85 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 86 | XFF_HEADER_REQUIRED=False) 87 | def test_too_many_proxies(self): 88 | response = self.client.get( 89 | '/', 90 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 91 | self.assert_http_bad_request(response) 92 | self.assertEqual(1, self.logger.warning.call_count) 93 | 94 | @override_settings(XFF_STRICT=True, XFF_TRUSTED_PROXY_DEPTH=2, 95 | XFF_HEADER_REQUIRED=False) 96 | def test_too_many_proxies_exempt(self): 97 | response = self.client.get( 98 | '/health/', 99 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 100 | self.assert_http_ok(response) 101 | assert not self.logger.method_calls 102 | 103 | @override_settings(XFF_LOOSE_UNSAFE=True, XFF_STRICT=True, 104 | XFF_TRUSTED_PROXY_DEPTH=2, XFF_HEADER_REQUIRED=True, 105 | XFF_NO_SPOOFING=True, XFF_ALWAYS_PROXY=True) 106 | def test_loose_no_header(self): 107 | response = self.client.get('/') 108 | self.assert_http_ok(response) 109 | assert not self.logger.method_calls 110 | 111 | @override_settings(XFF_LOOSE_UNSAFE=True, XFF_STRICT=True, 112 | XFF_TRUSTED_PROXY_DEPTH=2, XFF_HEADER_REQUIRED=True, 113 | XFF_NO_SPOOFING=True, XFF_ALWAYS_PROXY=True) 114 | def test_loose(self): 115 | response = self.client.get( 116 | '/', 117 | HTTP_X_FORWARDED_FOR='127.0.0.1') 118 | self.assert_http_ok(response, 'Too few addresses') 119 | response = self.client.get( 120 | '/', 121 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 122 | self.assert_http_ok(response, 'Correct addresses') 123 | response = self.client.get( 124 | '/', 125 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 126 | self.assert_http_ok(response, 'Too many addresses') 127 | assert not self.logger.method_calls 128 | 129 | 130 | class TestClean(WebTestCase): 131 | def setUp(self): 132 | self.middleware = XForwardedForMiddleware() 133 | self.client = Client() 134 | 135 | @override_settings(XFF_TRUSTED_PROXY_DEPTH=2) 136 | def test_too_many_proxies_rewrites_xff(self): 137 | response = self.client.get( 138 | '/', 139 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 140 | self.assert_http_ok(response) 141 | request = response.wsgi_request 142 | self.assertEqual('127.0.0.2,127.0.0.3', 143 | request.META['HTTP_X_FORWARDED_FOR']) 144 | 145 | @override_settings(XFF_TRUSTED_PROXY_DEPTH=2, XFF_CLEAN=False) 146 | def test_can_be_disabled(self): 147 | response = self.client.get( 148 | '/', 149 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 150 | self.assert_http_ok(response) 151 | request = response.wsgi_request 152 | self.assertEqual('127.0.0.1, 127.0.0.2, 127.0.0.3', 153 | request.META['HTTP_X_FORWARDED_FOR']) 154 | 155 | 156 | class TestRewriteRemote(WebTestCase): 157 | def setUp(self): 158 | self.middleware = XForwardedForMiddleware() 159 | self.client = Client() 160 | 161 | @override_settings(XFF_TRUSTED_PROXY_DEPTH=2) 162 | def test_rewrites_remote_addr(self): 163 | response = self.client.get( 164 | '/', 165 | HTTP_X_FORWARDED_FOR='127.0.0.3, 127.0.0.2', 166 | REMOTE_ADDR='127.0.0.9', 167 | ) 168 | self.assert_http_ok(response) 169 | request = response.wsgi_request 170 | self.assertEqual('127.0.0.3', 171 | request.META['REMOTE_ADDR']) 172 | 173 | @override_settings(XFF_TRUSTED_PROXY_DEPTH=2, XFF_REWRITE_REMOTE_ADDR=False) 174 | def test_can_be_disabled(self): 175 | response = self.client.get( 176 | '/', 177 | HTTP_X_FORWARDED_FOR='127.0.0.3, 127.0.0.2', 178 | REMOTE_ADDR='127.0.0.9', 179 | ) 180 | self.assert_http_ok(response) 181 | request = response.wsgi_request 182 | self.assertEqual('127.0.0.9', request.META['REMOTE_ADDR']) 183 | 184 | 185 | class TestProxyDepth(WebTestCase): 186 | def setUp(self): 187 | self.middleware = XForwardedForMiddleware() 188 | self.client = Client() 189 | self.patcher = patch('xff.middleware.logger', autospec=True) 190 | self.logger = self.patcher.start() 191 | 192 | def tearDown(self): 193 | self.patcher.stop() 194 | 195 | @override_settings(XFF_TRUSTED_PROXY_DEPTH=2) 196 | def test_too_many_proxies_logs_spoof_attempt(self): 197 | response = self.client.get( 198 | '/', 199 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 200 | self.assert_http_ok(response) 201 | expected_message = ( 202 | 'X-Forwarded-For spoof attempt with 3 addresses when 2 expected. ' 203 | 'Full header: 127.0.0.1, 127.0.0.2, 127.0.0.3' 204 | ) 205 | self.logger.info.assert_called_once_with(expected_message) 206 | 207 | 208 | 209 | class TestNoSpoofing(WebTestCase): 210 | def setUp(self): 211 | self.middleware = XForwardedForMiddleware() 212 | self.client = Client() 213 | self.patcher = patch('xff.middleware.logger', autospec=True) 214 | self.logger = self.patcher.start() 215 | 216 | def tearDown(self): 217 | self.patcher.stop() 218 | 219 | @override_settings(XFF_NO_SPOOFING=True) 220 | def test_no_header(self): 221 | response = self.client.get('/') 222 | self.assert_http_ok(response) 223 | assert not self.logger.method_calls 224 | 225 | @override_settings(XFF_NO_SPOOFING=True, XFF_TRUSTED_PROXY_DEPTH=2) 226 | def test_too_few_proxies(self): 227 | response = self.client.get('/', HTTP_X_FORWARDED_FOR='127.0.0.1') 228 | self.assert_http_ok(response) 229 | self.assertEqual(1, self.logger.warning.call_count) 230 | self.assertEqual(1, len(self.logger.method_calls)) 231 | 232 | @override_settings(XFF_NO_SPOOFING=True, XFF_TRUSTED_PROXY_DEPTH=2, 233 | XFF_HEADER_REQUIRED=False) 234 | def test_too_few_proxies_exempt(self): 235 | response = self.client.get('/health/', 236 | HTTP_X_FORWARDED_FOR='127.0.0.1') 237 | self.assert_http_ok(response) 238 | assert not self.logger.method_calls 239 | 240 | @override_settings(XFF_NO_SPOOFING=True, XFF_TRUSTED_PROXY_DEPTH=2, 241 | XFF_HEADER_REQUIRED=False) 242 | def test_correct_proxies(self): 243 | response = self.client.get( 244 | '/', 245 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2') 246 | self.assert_http_ok(response) 247 | assert not self.logger.method_calls 248 | 249 | @override_settings(XFF_NO_SPOOFING=True, XFF_TRUSTED_PROXY_DEPTH=2, 250 | XFF_HEADER_REQUIRED=False) 251 | def test_too_many_proxies(self): 252 | response = self.client.get( 253 | '/', 254 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 255 | self.assert_http_bad_request(response) 256 | self.assertEqual(1, self.logger.info.call_count) 257 | self.assertEqual(1, len(self.logger.method_calls)) 258 | 259 | @override_settings(XFF_NO_SPOOFING=True, XFF_TRUSTED_PROXY_DEPTH=2, 260 | XFF_HEADER_REQUIRED=False) 261 | def test_too_many_proxies_exempt(self): 262 | response = self.client.get( 263 | '/health/', HTTP_REMOTE_ADDR='', 264 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 265 | self.assert_http_ok(response) 266 | assert not self.logger.method_calls 267 | 268 | 269 | class TestAlwaysProxy(WebTestCase): 270 | def setUp(self): 271 | self.middleware = XForwardedForMiddleware() 272 | self.client = Client() 273 | self.patcher = patch('xff.middleware.logger', autospec=True) 274 | self.logger = self.patcher.start() 275 | 276 | def tearDown(self): 277 | self.patcher.stop() 278 | 279 | @override_settings(XFF_ALWAYS_PROXY=True) 280 | def test_no_header(self): 281 | response = self.client.get('/') 282 | self.assert_http_bad_request(response) 283 | self.assertEqual(1, self.logger.error.call_count) 284 | 285 | @override_settings(XFF_ALWAYS_PROXY=True) 286 | def test_no_header_exempt(self): 287 | response = self.client.get('/health/') 288 | self.assert_http_ok(response) 289 | assert not self.logger.method_calls 290 | 291 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_HEADER_REQUIRED=False) 292 | def test_no_header_not_required(self): 293 | response = self.client.get('/') 294 | self.assert_http_ok(response) 295 | assert not self.logger.method_calls 296 | 297 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_HEADER_REQUIRED=False) 298 | def test_no_header_not_required_exempt(self): 299 | response = self.client.get('/health/') 300 | self.assert_http_ok(response) 301 | assert not self.logger.method_calls 302 | 303 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_TRUSTED_PROXY_DEPTH=2, 304 | XFF_HEADER_REQUIRED=False) 305 | def test_too_few_proxies(self): 306 | response = self.client.get('/', HTTP_X_FORWARDED_FOR='127.0.0.1') 307 | self.assert_http_bad_request(response) 308 | self.assertEqual(1, self.logger.warning.call_count) 309 | 310 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_TRUSTED_PROXY_DEPTH=2, 311 | XFF_HEADER_REQUIRED=False) 312 | def test_too_few_proxies_exempt(self): 313 | response = self.client.get('/health/', 314 | HTTP_X_FORWARDED_FOR='127.0.0.1') 315 | self.assert_http_ok(response) 316 | assert not self.logger.method_calls 317 | 318 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_TRUSTED_PROXY_DEPTH=2, 319 | XFF_HEADER_REQUIRED=False) 320 | def test_correct_proxies(self): 321 | response = self.client.get( 322 | '/', 323 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2') 324 | self.assert_http_ok(response) 325 | assert not self.logger.method_calls 326 | 327 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_TRUSTED_PROXY_DEPTH=2, 328 | XFF_HEADER_REQUIRED=False) 329 | def test_too_many_proxies(self): 330 | response = self.client.get( 331 | '/', 332 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 333 | self.assert_http_ok(response) 334 | self.assertEqual(1, self.logger.info.call_count) 335 | 336 | @override_settings(XFF_ALWAYS_PROXY=True, XFF_TRUSTED_PROXY_DEPTH=2, 337 | XFF_HEADER_REQUIRED=False) 338 | def test_too_many_proxies_exempt(self): 339 | response = self.client.get( 340 | '/health/', HTTP_REMOTE_ADDR='', 341 | HTTP_X_FORWARDED_FOR='127.0.0.1, 127.0.0.2, 127.0.0.3') 342 | self.assert_http_ok(response) 343 | assert not self.logger.method_calls 344 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | 3 | envlist = 4 | flake8, 5 | py39-dj42 6 | py310-dj{42,50,51,master} 7 | py311-dj{42,50,51,master} 8 | py312-dj{42,50,51,master} 9 | py313-dj{42,50,51,master} 10 | 11 | [testenv] 12 | commands = py.test --cov xff {posargs} 13 | 14 | deps = 15 | dj42: Django>=4.2,<4.3 16 | dj50: Django>=5.0,<5.1 17 | dj51: Django>=5.1,<5.2 18 | djmaster: https://github.com/django/django/archive/master.tar.gz 19 | pytest-django 20 | pytest-cov 21 | pytest-xdist 22 | 23 | [travis] 24 | python = 25 | 3.9: py39-dj42 26 | 3.10: py310-dj{42,50,51,master} 27 | 3.11: py311-dj{42,50,51,master} 28 | 3.12: py312-dj{42,50,51,master} 29 | 3.13: py313-dj{42,50,51,master}, flake8 30 | 31 | [travis:env] 32 | DJANGO = 33 | 4.2: dj42 34 | 5.0: dj50 35 | 5.1: dj51 36 | master: djmaster 37 | 38 | [testenv:flake8] 39 | deps = flake8 40 | basepython = python3.13 41 | commands = flake8 xff tests 42 | -------------------------------------------------------------------------------- /versioneer.py: -------------------------------------------------------------------------------- 1 | 2 | # Version: 0.29 3 | 4 | """The Versioneer - like a rocketeer, but for versions. 5 | 6 | The Versioneer 7 | ============== 8 | 9 | * like a rocketeer, but for versions! 10 | * https://github.com/python-versioneer/python-versioneer 11 | * Brian Warner 12 | * License: Public Domain (Unlicense) 13 | * Compatible with: Python 3.7, 3.8, 3.9, 3.10, 3.11 and pypy3 14 | * [![Latest Version][pypi-image]][pypi-url] 15 | * [![Build Status][travis-image]][travis-url] 16 | 17 | This is a tool for managing a recorded version number in setuptools-based 18 | python projects. The goal is to remove the tedious and error-prone "update 19 | the embedded version string" step from your release process. Making a new 20 | release should be as easy as recording a new tag in your version-control 21 | system, and maybe making new tarballs. 22 | 23 | 24 | ## Quick Install 25 | 26 | Versioneer provides two installation modes. The "classic" vendored mode installs 27 | a copy of versioneer into your repository. The experimental build-time dependency mode 28 | is intended to allow you to skip this step and simplify the process of upgrading. 29 | 30 | ### Vendored mode 31 | 32 | * `pip install versioneer` to somewhere in your $PATH 33 | * A [conda-forge recipe](https://github.com/conda-forge/versioneer-feedstock) is 34 | available, so you can also use `conda install -c conda-forge versioneer` 35 | * add a `[tool.versioneer]` section to your `pyproject.toml` or a 36 | `[versioneer]` section to your `setup.cfg` (see [Install](INSTALL.md)) 37 | * Note that you will need to add `tomli; python_version < "3.11"` to your 38 | build-time dependencies if you use `pyproject.toml` 39 | * run `versioneer install --vendor` in your source tree, commit the results 40 | * verify version information with `python setup.py version` 41 | 42 | ### Build-time dependency mode 43 | 44 | * `pip install versioneer` to somewhere in your $PATH 45 | * A [conda-forge recipe](https://github.com/conda-forge/versioneer-feedstock) is 46 | available, so you can also use `conda install -c conda-forge versioneer` 47 | * add a `[tool.versioneer]` section to your `pyproject.toml` or a 48 | `[versioneer]` section to your `setup.cfg` (see [Install](INSTALL.md)) 49 | * add `versioneer` (with `[toml]` extra, if configuring in `pyproject.toml`) 50 | to the `requires` key of the `build-system` table in `pyproject.toml`: 51 | ```toml 52 | [build-system] 53 | requires = ["setuptools", "versioneer[toml]"] 54 | build-backend = "setuptools.build_meta" 55 | ``` 56 | * run `versioneer install --no-vendor` in your source tree, commit the results 57 | * verify version information with `python setup.py version` 58 | 59 | ## Version Identifiers 60 | 61 | Source trees come from a variety of places: 62 | 63 | * a version-control system checkout (mostly used by developers) 64 | * a nightly tarball, produced by build automation 65 | * a snapshot tarball, produced by a web-based VCS browser, like github's 66 | "tarball from tag" feature 67 | * a release tarball, produced by "setup.py sdist", distributed through PyPI 68 | 69 | Within each source tree, the version identifier (either a string or a number, 70 | this tool is format-agnostic) can come from a variety of places: 71 | 72 | * ask the VCS tool itself, e.g. "git describe" (for checkouts), which knows 73 | about recent "tags" and an absolute revision-id 74 | * the name of the directory into which the tarball was unpacked 75 | * an expanded VCS keyword ($Id$, etc) 76 | * a `_version.py` created by some earlier build step 77 | 78 | For released software, the version identifier is closely related to a VCS 79 | tag. Some projects use tag names that include more than just the version 80 | string (e.g. "myproject-1.2" instead of just "1.2"), in which case the tool 81 | needs to strip the tag prefix to extract the version identifier. For 82 | unreleased software (between tags), the version identifier should provide 83 | enough information to help developers recreate the same tree, while also 84 | giving them an idea of roughly how old the tree is (after version 1.2, before 85 | version 1.3). Many VCS systems can report a description that captures this, 86 | for example `git describe --tags --dirty --always` reports things like 87 | "0.7-1-g574ab98-dirty" to indicate that the checkout is one revision past the 88 | 0.7 tag, has a unique revision id of "574ab98", and is "dirty" (it has 89 | uncommitted changes). 90 | 91 | The version identifier is used for multiple purposes: 92 | 93 | * to allow the module to self-identify its version: `myproject.__version__` 94 | * to choose a name and prefix for a 'setup.py sdist' tarball 95 | 96 | ## Theory of Operation 97 | 98 | Versioneer works by adding a special `_version.py` file into your source 99 | tree, where your `__init__.py` can import it. This `_version.py` knows how to 100 | dynamically ask the VCS tool for version information at import time. 101 | 102 | `_version.py` also contains `$Revision$` markers, and the installation 103 | process marks `_version.py` to have this marker rewritten with a tag name 104 | during the `git archive` command. As a result, generated tarballs will 105 | contain enough information to get the proper version. 106 | 107 | To allow `setup.py` to compute a version too, a `versioneer.py` is added to 108 | the top level of your source tree, next to `setup.py` and the `setup.cfg` 109 | that configures it. This overrides several distutils/setuptools commands to 110 | compute the version when invoked, and changes `setup.py build` and `setup.py 111 | sdist` to replace `_version.py` with a small static file that contains just 112 | the generated version data. 113 | 114 | ## Installation 115 | 116 | See [INSTALL.md](./INSTALL.md) for detailed installation instructions. 117 | 118 | ## Version-String Flavors 119 | 120 | Code which uses Versioneer can learn about its version string at runtime by 121 | importing `_version` from your main `__init__.py` file and running the 122 | `get_versions()` function. From the "outside" (e.g. in `setup.py`), you can 123 | import the top-level `versioneer.py` and run `get_versions()`. 124 | 125 | Both functions return a dictionary with different flavors of version 126 | information: 127 | 128 | * `['version']`: A condensed version string, rendered using the selected 129 | style. This is the most commonly used value for the project's version 130 | string. The default "pep440" style yields strings like `0.11`, 131 | `0.11+2.g1076c97`, or `0.11+2.g1076c97.dirty`. See the "Styles" section 132 | below for alternative styles. 133 | 134 | * `['full-revisionid']`: detailed revision identifier. For Git, this is the 135 | full SHA1 commit id, e.g. "1076c978a8d3cfc70f408fe5974aa6c092c949ac". 136 | 137 | * `['date']`: Date and time of the latest `HEAD` commit. For Git, it is the 138 | commit date in ISO 8601 format. This will be None if the date is not 139 | available. 140 | 141 | * `['dirty']`: a boolean, True if the tree has uncommitted changes. Note that 142 | this is only accurate if run in a VCS checkout, otherwise it is likely to 143 | be False or None 144 | 145 | * `['error']`: if the version string could not be computed, this will be set 146 | to a string describing the problem, otherwise it will be None. It may be 147 | useful to throw an exception in setup.py if this is set, to avoid e.g. 148 | creating tarballs with a version string of "unknown". 149 | 150 | Some variants are more useful than others. Including `full-revisionid` in a 151 | bug report should allow developers to reconstruct the exact code being tested 152 | (or indicate the presence of local changes that should be shared with the 153 | developers). `version` is suitable for display in an "about" box or a CLI 154 | `--version` output: it can be easily compared against release notes and lists 155 | of bugs fixed in various releases. 156 | 157 | The installer adds the following text to your `__init__.py` to place a basic 158 | version in `YOURPROJECT.__version__`: 159 | 160 | from ._version import get_versions 161 | __version__ = get_versions()['version'] 162 | del get_versions 163 | 164 | ## Styles 165 | 166 | The setup.cfg `style=` configuration controls how the VCS information is 167 | rendered into a version string. 168 | 169 | The default style, "pep440", produces a PEP440-compliant string, equal to the 170 | un-prefixed tag name for actual releases, and containing an additional "local 171 | version" section with more detail for in-between builds. For Git, this is 172 | TAG[+DISTANCE.gHEX[.dirty]] , using information from `git describe --tags 173 | --dirty --always`. For example "0.11+2.g1076c97.dirty" indicates that the 174 | tree is like the "1076c97" commit but has uncommitted changes (".dirty"), and 175 | that this commit is two revisions ("+2") beyond the "0.11" tag. For released 176 | software (exactly equal to a known tag), the identifier will only contain the 177 | stripped tag, e.g. "0.11". 178 | 179 | Other styles are available. See [details.md](details.md) in the Versioneer 180 | source tree for descriptions. 181 | 182 | ## Debugging 183 | 184 | Versioneer tries to avoid fatal errors: if something goes wrong, it will tend 185 | to return a version of "0+unknown". To investigate the problem, run `setup.py 186 | version`, which will run the version-lookup code in a verbose mode, and will 187 | display the full contents of `get_versions()` (including the `error` string, 188 | which may help identify what went wrong). 189 | 190 | ## Known Limitations 191 | 192 | Some situations are known to cause problems for Versioneer. This details the 193 | most significant ones. More can be found on Github 194 | [issues page](https://github.com/python-versioneer/python-versioneer/issues). 195 | 196 | ### Subprojects 197 | 198 | Versioneer has limited support for source trees in which `setup.py` is not in 199 | the root directory (e.g. `setup.py` and `.git/` are *not* siblings). The are 200 | two common reasons why `setup.py` might not be in the root: 201 | 202 | * Source trees which contain multiple subprojects, such as 203 | [Buildbot](https://github.com/buildbot/buildbot), which contains both 204 | "master" and "slave" subprojects, each with their own `setup.py`, 205 | `setup.cfg`, and `tox.ini`. Projects like these produce multiple PyPI 206 | distributions (and upload multiple independently-installable tarballs). 207 | * Source trees whose main purpose is to contain a C library, but which also 208 | provide bindings to Python (and perhaps other languages) in subdirectories. 209 | 210 | Versioneer will look for `.git` in parent directories, and most operations 211 | should get the right version string. However `pip` and `setuptools` have bugs 212 | and implementation details which frequently cause `pip install .` from a 213 | subproject directory to fail to find a correct version string (so it usually 214 | defaults to `0+unknown`). 215 | 216 | `pip install --editable .` should work correctly. `setup.py install` might 217 | work too. 218 | 219 | Pip-8.1.1 is known to have this problem, but hopefully it will get fixed in 220 | some later version. 221 | 222 | [Bug #38](https://github.com/python-versioneer/python-versioneer/issues/38) is tracking 223 | this issue. The discussion in 224 | [PR #61](https://github.com/python-versioneer/python-versioneer/pull/61) describes the 225 | issue from the Versioneer side in more detail. 226 | [pip PR#3176](https://github.com/pypa/pip/pull/3176) and 227 | [pip PR#3615](https://github.com/pypa/pip/pull/3615) contain work to improve 228 | pip to let Versioneer work correctly. 229 | 230 | Versioneer-0.16 and earlier only looked for a `.git` directory next to the 231 | `setup.cfg`, so subprojects were completely unsupported with those releases. 232 | 233 | ### Editable installs with setuptools <= 18.5 234 | 235 | `setup.py develop` and `pip install --editable .` allow you to install a 236 | project into a virtualenv once, then continue editing the source code (and 237 | test) without re-installing after every change. 238 | 239 | "Entry-point scripts" (`setup(entry_points={"console_scripts": ..})`) are a 240 | convenient way to specify executable scripts that should be installed along 241 | with the python package. 242 | 243 | These both work as expected when using modern setuptools. When using 244 | setuptools-18.5 or earlier, however, certain operations will cause 245 | `pkg_resources.DistributionNotFound` errors when running the entrypoint 246 | script, which must be resolved by re-installing the package. This happens 247 | when the install happens with one version, then the egg_info data is 248 | regenerated while a different version is checked out. Many setup.py commands 249 | cause egg_info to be rebuilt (including `sdist`, `wheel`, and installing into 250 | a different virtualenv), so this can be surprising. 251 | 252 | [Bug #83](https://github.com/python-versioneer/python-versioneer/issues/83) describes 253 | this one, but upgrading to a newer version of setuptools should probably 254 | resolve it. 255 | 256 | 257 | ## Updating Versioneer 258 | 259 | To upgrade your project to a new release of Versioneer, do the following: 260 | 261 | * install the new Versioneer (`pip install -U versioneer` or equivalent) 262 | * edit `setup.cfg` and `pyproject.toml`, if necessary, 263 | to include any new configuration settings indicated by the release notes. 264 | See [UPGRADING](./UPGRADING.md) for details. 265 | * re-run `versioneer install --[no-]vendor` in your source tree, to replace 266 | `SRC/_version.py` 267 | * commit any changed files 268 | 269 | ## Future Directions 270 | 271 | This tool is designed to make it easily extended to other version-control 272 | systems: all VCS-specific components are in separate directories like 273 | src/git/ . The top-level `versioneer.py` script is assembled from these 274 | components by running make-versioneer.py . In the future, make-versioneer.py 275 | will take a VCS name as an argument, and will construct a version of 276 | `versioneer.py` that is specific to the given VCS. It might also take the 277 | configuration arguments that are currently provided manually during 278 | installation by editing setup.py . Alternatively, it might go the other 279 | direction and include code from all supported VCS systems, reducing the 280 | number of intermediate scripts. 281 | 282 | ## Similar projects 283 | 284 | * [setuptools_scm](https://github.com/pypa/setuptools_scm/) - a non-vendored build-time 285 | dependency 286 | * [minver](https://github.com/jbweston/miniver) - a lightweight reimplementation of 287 | versioneer 288 | * [versioningit](https://github.com/jwodder/versioningit) - a PEP 518-based setuptools 289 | plugin 290 | 291 | ## License 292 | 293 | To make Versioneer easier to embed, all its code is dedicated to the public 294 | domain. The `_version.py` that it creates is also in the public domain. 295 | Specifically, both are released under the "Unlicense", as described in 296 | https://unlicense.org/. 297 | 298 | [pypi-image]: https://img.shields.io/pypi/v/versioneer.svg 299 | [pypi-url]: https://pypi.python.org/pypi/versioneer/ 300 | [travis-image]: 301 | https://img.shields.io/travis/com/python-versioneer/python-versioneer.svg 302 | [travis-url]: https://travis-ci.com/github/python-versioneer/python-versioneer 303 | 304 | """ 305 | # pylint:disable=invalid-name,import-outside-toplevel,missing-function-docstring 306 | # pylint:disable=missing-class-docstring,too-many-branches,too-many-statements 307 | # pylint:disable=raise-missing-from,too-many-lines,too-many-locals,import-error 308 | # pylint:disable=too-few-public-methods,redefined-outer-name,consider-using-with 309 | # pylint:disable=attribute-defined-outside-init,too-many-arguments 310 | 311 | import configparser 312 | import errno 313 | import json 314 | import os 315 | import re 316 | import subprocess 317 | import sys 318 | from pathlib import Path 319 | from typing import Any, Callable, cast, Dict, List, Optional, Tuple, Union 320 | from typing import NoReturn 321 | import functools 322 | 323 | have_tomllib = True 324 | if sys.version_info >= (3, 11): 325 | import tomllib 326 | else: 327 | try: 328 | import tomli as tomllib 329 | except ImportError: 330 | have_tomllib = False 331 | 332 | 333 | class VersioneerConfig: 334 | """Container for Versioneer configuration parameters.""" 335 | 336 | VCS: str 337 | style: str 338 | tag_prefix: str 339 | versionfile_source: str 340 | versionfile_build: Optional[str] 341 | parentdir_prefix: Optional[str] 342 | verbose: Optional[bool] 343 | 344 | 345 | def get_root() -> str: 346 | """Get the project root directory. 347 | 348 | We require that all commands are run from the project root, i.e. the 349 | directory that contains setup.py, setup.cfg, and versioneer.py . 350 | """ 351 | root = os.path.realpath(os.path.abspath(os.getcwd())) 352 | setup_py = os.path.join(root, "setup.py") 353 | pyproject_toml = os.path.join(root, "pyproject.toml") 354 | versioneer_py = os.path.join(root, "versioneer.py") 355 | if not ( 356 | os.path.exists(setup_py) 357 | or os.path.exists(pyproject_toml) 358 | or os.path.exists(versioneer_py) 359 | ): 360 | # allow 'python path/to/setup.py COMMAND' 361 | root = os.path.dirname(os.path.realpath(os.path.abspath(sys.argv[0]))) 362 | setup_py = os.path.join(root, "setup.py") 363 | pyproject_toml = os.path.join(root, "pyproject.toml") 364 | versioneer_py = os.path.join(root, "versioneer.py") 365 | if not ( 366 | os.path.exists(setup_py) 367 | or os.path.exists(pyproject_toml) 368 | or os.path.exists(versioneer_py) 369 | ): 370 | err = ("Versioneer was unable to run the project root directory. " 371 | "Versioneer requires setup.py to be executed from " 372 | "its immediate directory (like 'python setup.py COMMAND'), " 373 | "or in a way that lets it use sys.argv[0] to find the root " 374 | "(like 'python path/to/setup.py COMMAND').") 375 | raise VersioneerBadRootError(err) 376 | try: 377 | # Certain runtime workflows (setup.py install/develop in a setuptools 378 | # tree) execute all dependencies in a single python process, so 379 | # "versioneer" may be imported multiple times, and python's shared 380 | # module-import table will cache the first one. So we can't use 381 | # os.path.dirname(__file__), as that will find whichever 382 | # versioneer.py was first imported, even in later projects. 383 | my_path = os.path.realpath(os.path.abspath(__file__)) 384 | me_dir = os.path.normcase(os.path.splitext(my_path)[0]) 385 | vsr_dir = os.path.normcase(os.path.splitext(versioneer_py)[0]) 386 | if me_dir != vsr_dir and "VERSIONEER_PEP518" not in globals(): 387 | print("Warning: build in %s is using versioneer.py from %s" 388 | % (os.path.dirname(my_path), versioneer_py)) 389 | except NameError: 390 | pass 391 | return root 392 | 393 | 394 | def get_config_from_root(root: str) -> VersioneerConfig: 395 | """Read the project setup.cfg file to determine Versioneer config.""" 396 | # This might raise OSError (if setup.cfg is missing), or 397 | # configparser.NoSectionError (if it lacks a [versioneer] section), or 398 | # configparser.NoOptionError (if it lacks "VCS="). See the docstring at 399 | # the top of versioneer.py for instructions on writing your setup.cfg . 400 | root_pth = Path(root) 401 | pyproject_toml = root_pth / "pyproject.toml" 402 | setup_cfg = root_pth / "setup.cfg" 403 | section: Union[Dict[str, Any], configparser.SectionProxy, None] = None 404 | if pyproject_toml.exists() and have_tomllib: 405 | try: 406 | with open(pyproject_toml, 'rb') as fobj: 407 | pp = tomllib.load(fobj) 408 | section = pp['tool']['versioneer'] 409 | except (tomllib.TOMLDecodeError, KeyError) as e: 410 | print(f"Failed to load config from {pyproject_toml}: {e}") 411 | print("Try to load it from setup.cfg") 412 | if not section: 413 | parser = configparser.ConfigParser() 414 | with open(setup_cfg) as cfg_file: 415 | parser.read_file(cfg_file) 416 | parser.get("versioneer", "VCS") # raise error if missing 417 | 418 | section = parser["versioneer"] 419 | 420 | # `cast`` really shouldn't be used, but its simplest for the 421 | # common VersioneerConfig users at the moment. We verify against 422 | # `None` values elsewhere where it matters 423 | 424 | cfg = VersioneerConfig() 425 | cfg.VCS = section['VCS'] 426 | cfg.style = section.get("style", "") 427 | cfg.versionfile_source = cast(str, section.get("versionfile_source")) 428 | cfg.versionfile_build = section.get("versionfile_build") 429 | cfg.tag_prefix = cast(str, section.get("tag_prefix")) 430 | if cfg.tag_prefix in ("''", '""', None): 431 | cfg.tag_prefix = "" 432 | cfg.parentdir_prefix = section.get("parentdir_prefix") 433 | if isinstance(section, configparser.SectionProxy): 434 | # Make sure configparser translates to bool 435 | cfg.verbose = section.getboolean("verbose") 436 | else: 437 | cfg.verbose = section.get("verbose") 438 | 439 | return cfg 440 | 441 | 442 | class NotThisMethod(Exception): 443 | """Exception raised if a method is not valid for the current scenario.""" 444 | 445 | 446 | # these dictionaries contain VCS-specific tools 447 | LONG_VERSION_PY: Dict[str, str] = {} 448 | HANDLERS: Dict[str, Dict[str, Callable]] = {} 449 | 450 | 451 | def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator 452 | """Create decorator to mark a method as the handler of a VCS.""" 453 | def decorate(f: Callable) -> Callable: 454 | """Store f in HANDLERS[vcs][method].""" 455 | HANDLERS.setdefault(vcs, {})[method] = f 456 | return f 457 | return decorate 458 | 459 | 460 | def run_command( 461 | commands: List[str], 462 | args: List[str], 463 | cwd: Optional[str] = None, 464 | verbose: bool = False, 465 | hide_stderr: bool = False, 466 | env: Optional[Dict[str, str]] = None, 467 | ) -> Tuple[Optional[str], Optional[int]]: 468 | """Call the given command(s).""" 469 | assert isinstance(commands, list) 470 | process = None 471 | 472 | popen_kwargs: Dict[str, Any] = {} 473 | if sys.platform == "win32": 474 | # This hides the console window if pythonw.exe is used 475 | startupinfo = subprocess.STARTUPINFO() 476 | startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW 477 | popen_kwargs["startupinfo"] = startupinfo 478 | 479 | for command in commands: 480 | try: 481 | dispcmd = str([command] + args) 482 | # remember shell=False, so use git.cmd on windows, not just git 483 | process = subprocess.Popen([command] + args, cwd=cwd, env=env, 484 | stdout=subprocess.PIPE, 485 | stderr=(subprocess.PIPE if hide_stderr 486 | else None), **popen_kwargs) 487 | break 488 | except OSError as e: 489 | if e.errno == errno.ENOENT: 490 | continue 491 | if verbose: 492 | print("unable to run %s" % dispcmd) 493 | print(e) 494 | return None, None 495 | else: 496 | if verbose: 497 | print("unable to find command, tried %s" % (commands,)) 498 | return None, None 499 | stdout = process.communicate()[0].strip().decode() 500 | if process.returncode != 0: 501 | if verbose: 502 | print("unable to run %s (error)" % dispcmd) 503 | print("stdout was %s" % stdout) 504 | return None, process.returncode 505 | return stdout, process.returncode 506 | 507 | 508 | LONG_VERSION_PY['git'] = r''' 509 | # This file helps to compute a version number in source trees obtained from 510 | # git-archive tarball (such as those provided by githubs download-from-tag 511 | # feature). Distribution tarballs (built by setup.py sdist) and build 512 | # directories (produced by setup.py build) will contain a much shorter file 513 | # that just contains the computed version number. 514 | 515 | # This file is released into the public domain. 516 | # Generated by versioneer-0.29 517 | # https://github.com/python-versioneer/python-versioneer 518 | 519 | """Git implementation of _version.py.""" 520 | 521 | import errno 522 | import os 523 | import re 524 | import subprocess 525 | import sys 526 | from typing import Any, Callable, Dict, List, Optional, Tuple 527 | import functools 528 | 529 | 530 | def get_keywords() -> Dict[str, str]: 531 | """Get the keywords needed to look up the version information.""" 532 | # these strings will be replaced by git during git-archive. 533 | # setup.py/versioneer.py will grep for the variable names, so they must 534 | # each be defined on a line of their own. _version.py will just call 535 | # get_keywords(). 536 | git_refnames = "%(DOLLAR)sFormat:%%d%(DOLLAR)s" 537 | git_full = "%(DOLLAR)sFormat:%%H%(DOLLAR)s" 538 | git_date = "%(DOLLAR)sFormat:%%ci%(DOLLAR)s" 539 | keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} 540 | return keywords 541 | 542 | 543 | class VersioneerConfig: 544 | """Container for Versioneer configuration parameters.""" 545 | 546 | VCS: str 547 | style: str 548 | tag_prefix: str 549 | parentdir_prefix: str 550 | versionfile_source: str 551 | verbose: bool 552 | 553 | 554 | def get_config() -> VersioneerConfig: 555 | """Create, populate and return the VersioneerConfig() object.""" 556 | # these strings are filled in when 'setup.py versioneer' creates 557 | # _version.py 558 | cfg = VersioneerConfig() 559 | cfg.VCS = "git" 560 | cfg.style = "%(STYLE)s" 561 | cfg.tag_prefix = "%(TAG_PREFIX)s" 562 | cfg.parentdir_prefix = "%(PARENTDIR_PREFIX)s" 563 | cfg.versionfile_source = "%(VERSIONFILE_SOURCE)s" 564 | cfg.verbose = False 565 | return cfg 566 | 567 | 568 | class NotThisMethod(Exception): 569 | """Exception raised if a method is not valid for the current scenario.""" 570 | 571 | 572 | LONG_VERSION_PY: Dict[str, str] = {} 573 | HANDLERS: Dict[str, Dict[str, Callable]] = {} 574 | 575 | 576 | def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator 577 | """Create decorator to mark a method as the handler of a VCS.""" 578 | def decorate(f: Callable) -> Callable: 579 | """Store f in HANDLERS[vcs][method].""" 580 | if vcs not in HANDLERS: 581 | HANDLERS[vcs] = {} 582 | HANDLERS[vcs][method] = f 583 | return f 584 | return decorate 585 | 586 | 587 | def run_command( 588 | commands: List[str], 589 | args: List[str], 590 | cwd: Optional[str] = None, 591 | verbose: bool = False, 592 | hide_stderr: bool = False, 593 | env: Optional[Dict[str, str]] = None, 594 | ) -> Tuple[Optional[str], Optional[int]]: 595 | """Call the given command(s).""" 596 | assert isinstance(commands, list) 597 | process = None 598 | 599 | popen_kwargs: Dict[str, Any] = {} 600 | if sys.platform == "win32": 601 | # This hides the console window if pythonw.exe is used 602 | startupinfo = subprocess.STARTUPINFO() 603 | startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW 604 | popen_kwargs["startupinfo"] = startupinfo 605 | 606 | for command in commands: 607 | try: 608 | dispcmd = str([command] + args) 609 | # remember shell=False, so use git.cmd on windows, not just git 610 | process = subprocess.Popen([command] + args, cwd=cwd, env=env, 611 | stdout=subprocess.PIPE, 612 | stderr=(subprocess.PIPE if hide_stderr 613 | else None), **popen_kwargs) 614 | break 615 | except OSError as e: 616 | if e.errno == errno.ENOENT: 617 | continue 618 | if verbose: 619 | print("unable to run %%s" %% dispcmd) 620 | print(e) 621 | return None, None 622 | else: 623 | if verbose: 624 | print("unable to find command, tried %%s" %% (commands,)) 625 | return None, None 626 | stdout = process.communicate()[0].strip().decode() 627 | if process.returncode != 0: 628 | if verbose: 629 | print("unable to run %%s (error)" %% dispcmd) 630 | print("stdout was %%s" %% stdout) 631 | return None, process.returncode 632 | return stdout, process.returncode 633 | 634 | 635 | def versions_from_parentdir( 636 | parentdir_prefix: str, 637 | root: str, 638 | verbose: bool, 639 | ) -> Dict[str, Any]: 640 | """Try to determine the version from the parent directory name. 641 | 642 | Source tarballs conventionally unpack into a directory that includes both 643 | the project name and a version string. We will also support searching up 644 | two directory levels for an appropriately named parent directory 645 | """ 646 | rootdirs = [] 647 | 648 | for _ in range(3): 649 | dirname = os.path.basename(root) 650 | if dirname.startswith(parentdir_prefix): 651 | return {"version": dirname[len(parentdir_prefix):], 652 | "full-revisionid": None, 653 | "dirty": False, "error": None, "date": None} 654 | rootdirs.append(root) 655 | root = os.path.dirname(root) # up a level 656 | 657 | if verbose: 658 | print("Tried directories %%s but none started with prefix %%s" %% 659 | (str(rootdirs), parentdir_prefix)) 660 | raise NotThisMethod("rootdir doesn't start with parentdir_prefix") 661 | 662 | 663 | @register_vcs_handler("git", "get_keywords") 664 | def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: 665 | """Extract version information from the given file.""" 666 | # the code embedded in _version.py can just fetch the value of these 667 | # keywords. When used from setup.py, we don't want to import _version.py, 668 | # so we do it with a regexp instead. This function is not used from 669 | # _version.py. 670 | keywords: Dict[str, str] = {} 671 | try: 672 | with open(versionfile_abs, "r") as fobj: 673 | for line in fobj: 674 | if line.strip().startswith("git_refnames ="): 675 | mo = re.search(r'=\s*"(.*)"', line) 676 | if mo: 677 | keywords["refnames"] = mo.group(1) 678 | if line.strip().startswith("git_full ="): 679 | mo = re.search(r'=\s*"(.*)"', line) 680 | if mo: 681 | keywords["full"] = mo.group(1) 682 | if line.strip().startswith("git_date ="): 683 | mo = re.search(r'=\s*"(.*)"', line) 684 | if mo: 685 | keywords["date"] = mo.group(1) 686 | except OSError: 687 | pass 688 | return keywords 689 | 690 | 691 | @register_vcs_handler("git", "keywords") 692 | def git_versions_from_keywords( 693 | keywords: Dict[str, str], 694 | tag_prefix: str, 695 | verbose: bool, 696 | ) -> Dict[str, Any]: 697 | """Get version information from git keywords.""" 698 | if "refnames" not in keywords: 699 | raise NotThisMethod("Short version file found") 700 | date = keywords.get("date") 701 | if date is not None: 702 | # Use only the last line. Previous lines may contain GPG signature 703 | # information. 704 | date = date.splitlines()[-1] 705 | 706 | # git-2.2.0 added "%%cI", which expands to an ISO-8601 -compliant 707 | # datestamp. However we prefer "%%ci" (which expands to an "ISO-8601 708 | # -like" string, which we must then edit to make compliant), because 709 | # it's been around since git-1.5.3, and it's too difficult to 710 | # discover which version we're using, or to work around using an 711 | # older one. 712 | date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 713 | refnames = keywords["refnames"].strip() 714 | if refnames.startswith("$Format"): 715 | if verbose: 716 | print("keywords are unexpanded, not using") 717 | raise NotThisMethod("unexpanded keywords, not a git-archive tarball") 718 | refs = {r.strip() for r in refnames.strip("()").split(",")} 719 | # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of 720 | # just "foo-1.0". If we see a "tag: " prefix, prefer those. 721 | TAG = "tag: " 722 | tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} 723 | if not tags: 724 | # Either we're using git < 1.8.3, or there really are no tags. We use 725 | # a heuristic: assume all version tags have a digit. The old git %%d 726 | # expansion behaves like git log --decorate=short and strips out the 727 | # refs/heads/ and refs/tags/ prefixes that would let us distinguish 728 | # between branches and tags. By ignoring refnames without digits, we 729 | # filter out many common branch names like "release" and 730 | # "stabilization", as well as "HEAD" and "master". 731 | tags = {r for r in refs if re.search(r'\d', r)} 732 | if verbose: 733 | print("discarding '%%s', no digits" %% ",".join(refs - tags)) 734 | if verbose: 735 | print("likely tags: %%s" %% ",".join(sorted(tags))) 736 | for ref in sorted(tags): 737 | # sorting will prefer e.g. "2.0" over "2.0rc1" 738 | if ref.startswith(tag_prefix): 739 | r = ref[len(tag_prefix):] 740 | # Filter out refs that exactly match prefix or that don't start 741 | # with a number once the prefix is stripped (mostly a concern 742 | # when prefix is '') 743 | if not re.match(r'\d', r): 744 | continue 745 | if verbose: 746 | print("picking %%s" %% r) 747 | return {"version": r, 748 | "full-revisionid": keywords["full"].strip(), 749 | "dirty": False, "error": None, 750 | "date": date} 751 | # no suitable tags, so version is "0+unknown", but full hex is still there 752 | if verbose: 753 | print("no suitable tags, using unknown + full revision id") 754 | return {"version": "0+unknown", 755 | "full-revisionid": keywords["full"].strip(), 756 | "dirty": False, "error": "no suitable tags", "date": None} 757 | 758 | 759 | @register_vcs_handler("git", "pieces_from_vcs") 760 | def git_pieces_from_vcs( 761 | tag_prefix: str, 762 | root: str, 763 | verbose: bool, 764 | runner: Callable = run_command 765 | ) -> Dict[str, Any]: 766 | """Get version from 'git describe' in the root of the source tree. 767 | 768 | This only gets called if the git-archive 'subst' keywords were *not* 769 | expanded, and _version.py hasn't already been rewritten with a short 770 | version string, meaning we're inside a checked out source tree. 771 | """ 772 | GITS = ["git"] 773 | if sys.platform == "win32": 774 | GITS = ["git.cmd", "git.exe"] 775 | 776 | # GIT_DIR can interfere with correct operation of Versioneer. 777 | # It may be intended to be passed to the Versioneer-versioned project, 778 | # but that should not change where we get our version from. 779 | env = os.environ.copy() 780 | env.pop("GIT_DIR", None) 781 | runner = functools.partial(runner, env=env) 782 | 783 | _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, 784 | hide_stderr=not verbose) 785 | if rc != 0: 786 | if verbose: 787 | print("Directory %%s not under git control" %% root) 788 | raise NotThisMethod("'git rev-parse --git-dir' returned error") 789 | 790 | # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] 791 | # if there isn't one, this yields HEX[-dirty] (no NUM) 792 | describe_out, rc = runner(GITS, [ 793 | "describe", "--tags", "--dirty", "--always", "--long", 794 | "--match", f"{tag_prefix}[[:digit:]]*" 795 | ], cwd=root) 796 | # --long was added in git-1.5.5 797 | if describe_out is None: 798 | raise NotThisMethod("'git describe' failed") 799 | describe_out = describe_out.strip() 800 | full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) 801 | if full_out is None: 802 | raise NotThisMethod("'git rev-parse' failed") 803 | full_out = full_out.strip() 804 | 805 | pieces: Dict[str, Any] = {} 806 | pieces["long"] = full_out 807 | pieces["short"] = full_out[:7] # maybe improved later 808 | pieces["error"] = None 809 | 810 | branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], 811 | cwd=root) 812 | # --abbrev-ref was added in git-1.6.3 813 | if rc != 0 or branch_name is None: 814 | raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") 815 | branch_name = branch_name.strip() 816 | 817 | if branch_name == "HEAD": 818 | # If we aren't exactly on a branch, pick a branch which represents 819 | # the current commit. If all else fails, we are on a branchless 820 | # commit. 821 | branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) 822 | # --contains was added in git-1.5.4 823 | if rc != 0 or branches is None: 824 | raise NotThisMethod("'git branch --contains' returned error") 825 | branches = branches.split("\n") 826 | 827 | # Remove the first line if we're running detached 828 | if "(" in branches[0]: 829 | branches.pop(0) 830 | 831 | # Strip off the leading "* " from the list of branches. 832 | branches = [branch[2:] for branch in branches] 833 | if "master" in branches: 834 | branch_name = "master" 835 | elif not branches: 836 | branch_name = None 837 | else: 838 | # Pick the first branch that is returned. Good or bad. 839 | branch_name = branches[0] 840 | 841 | pieces["branch"] = branch_name 842 | 843 | # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] 844 | # TAG might have hyphens. 845 | git_describe = describe_out 846 | 847 | # look for -dirty suffix 848 | dirty = git_describe.endswith("-dirty") 849 | pieces["dirty"] = dirty 850 | if dirty: 851 | git_describe = git_describe[:git_describe.rindex("-dirty")] 852 | 853 | # now we have TAG-NUM-gHEX or HEX 854 | 855 | if "-" in git_describe: 856 | # TAG-NUM-gHEX 857 | mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) 858 | if not mo: 859 | # unparsable. Maybe git-describe is misbehaving? 860 | pieces["error"] = ("unable to parse git-describe output: '%%s'" 861 | %% describe_out) 862 | return pieces 863 | 864 | # tag 865 | full_tag = mo.group(1) 866 | if not full_tag.startswith(tag_prefix): 867 | if verbose: 868 | fmt = "tag '%%s' doesn't start with prefix '%%s'" 869 | print(fmt %% (full_tag, tag_prefix)) 870 | pieces["error"] = ("tag '%%s' doesn't start with prefix '%%s'" 871 | %% (full_tag, tag_prefix)) 872 | return pieces 873 | pieces["closest-tag"] = full_tag[len(tag_prefix):] 874 | 875 | # distance: number of commits since tag 876 | pieces["distance"] = int(mo.group(2)) 877 | 878 | # commit: short hex revision ID 879 | pieces["short"] = mo.group(3) 880 | 881 | else: 882 | # HEX: no tags 883 | pieces["closest-tag"] = None 884 | out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) 885 | pieces["distance"] = len(out.split()) # total number of commits 886 | 887 | # commit date: see ISO-8601 comment in git_versions_from_keywords() 888 | date = runner(GITS, ["show", "-s", "--format=%%ci", "HEAD"], cwd=root)[0].strip() 889 | # Use only the last line. Previous lines may contain GPG signature 890 | # information. 891 | date = date.splitlines()[-1] 892 | pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 893 | 894 | return pieces 895 | 896 | 897 | def plus_or_dot(pieces: Dict[str, Any]) -> str: 898 | """Return a + if we don't already have one, else return a .""" 899 | if "+" in pieces.get("closest-tag", ""): 900 | return "." 901 | return "+" 902 | 903 | 904 | def render_pep440(pieces: Dict[str, Any]) -> str: 905 | """Build up version string, with post-release "local version identifier". 906 | 907 | Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you 908 | get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty 909 | 910 | Exceptions: 911 | 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] 912 | """ 913 | if pieces["closest-tag"]: 914 | rendered = pieces["closest-tag"] 915 | if pieces["distance"] or pieces["dirty"]: 916 | rendered += plus_or_dot(pieces) 917 | rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) 918 | if pieces["dirty"]: 919 | rendered += ".dirty" 920 | else: 921 | # exception #1 922 | rendered = "0+untagged.%%d.g%%s" %% (pieces["distance"], 923 | pieces["short"]) 924 | if pieces["dirty"]: 925 | rendered += ".dirty" 926 | return rendered 927 | 928 | 929 | def render_pep440_branch(pieces: Dict[str, Any]) -> str: 930 | """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . 931 | 932 | The ".dev0" means not master branch. Note that .dev0 sorts backwards 933 | (a feature branch will appear "older" than the master branch). 934 | 935 | Exceptions: 936 | 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] 937 | """ 938 | if pieces["closest-tag"]: 939 | rendered = pieces["closest-tag"] 940 | if pieces["distance"] or pieces["dirty"]: 941 | if pieces["branch"] != "master": 942 | rendered += ".dev0" 943 | rendered += plus_or_dot(pieces) 944 | rendered += "%%d.g%%s" %% (pieces["distance"], pieces["short"]) 945 | if pieces["dirty"]: 946 | rendered += ".dirty" 947 | else: 948 | # exception #1 949 | rendered = "0" 950 | if pieces["branch"] != "master": 951 | rendered += ".dev0" 952 | rendered += "+untagged.%%d.g%%s" %% (pieces["distance"], 953 | pieces["short"]) 954 | if pieces["dirty"]: 955 | rendered += ".dirty" 956 | return rendered 957 | 958 | 959 | def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: 960 | """Split pep440 version string at the post-release segment. 961 | 962 | Returns the release segments before the post-release and the 963 | post-release version number (or -1 if no post-release segment is present). 964 | """ 965 | vc = str.split(ver, ".post") 966 | return vc[0], int(vc[1] or 0) if len(vc) == 2 else None 967 | 968 | 969 | def render_pep440_pre(pieces: Dict[str, Any]) -> str: 970 | """TAG[.postN.devDISTANCE] -- No -dirty. 971 | 972 | Exceptions: 973 | 1: no tags. 0.post0.devDISTANCE 974 | """ 975 | if pieces["closest-tag"]: 976 | if pieces["distance"]: 977 | # update the post release segment 978 | tag_version, post_version = pep440_split_post(pieces["closest-tag"]) 979 | rendered = tag_version 980 | if post_version is not None: 981 | rendered += ".post%%d.dev%%d" %% (post_version + 1, pieces["distance"]) 982 | else: 983 | rendered += ".post0.dev%%d" %% (pieces["distance"]) 984 | else: 985 | # no commits, use the tag as the version 986 | rendered = pieces["closest-tag"] 987 | else: 988 | # exception #1 989 | rendered = "0.post0.dev%%d" %% pieces["distance"] 990 | return rendered 991 | 992 | 993 | def render_pep440_post(pieces: Dict[str, Any]) -> str: 994 | """TAG[.postDISTANCE[.dev0]+gHEX] . 995 | 996 | The ".dev0" means dirty. Note that .dev0 sorts backwards 997 | (a dirty tree will appear "older" than the corresponding clean one), 998 | but you shouldn't be releasing software with -dirty anyways. 999 | 1000 | Exceptions: 1001 | 1: no tags. 0.postDISTANCE[.dev0] 1002 | """ 1003 | if pieces["closest-tag"]: 1004 | rendered = pieces["closest-tag"] 1005 | if pieces["distance"] or pieces["dirty"]: 1006 | rendered += ".post%%d" %% pieces["distance"] 1007 | if pieces["dirty"]: 1008 | rendered += ".dev0" 1009 | rendered += plus_or_dot(pieces) 1010 | rendered += "g%%s" %% pieces["short"] 1011 | else: 1012 | # exception #1 1013 | rendered = "0.post%%d" %% pieces["distance"] 1014 | if pieces["dirty"]: 1015 | rendered += ".dev0" 1016 | rendered += "+g%%s" %% pieces["short"] 1017 | return rendered 1018 | 1019 | 1020 | def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: 1021 | """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . 1022 | 1023 | The ".dev0" means not master branch. 1024 | 1025 | Exceptions: 1026 | 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] 1027 | """ 1028 | if pieces["closest-tag"]: 1029 | rendered = pieces["closest-tag"] 1030 | if pieces["distance"] or pieces["dirty"]: 1031 | rendered += ".post%%d" %% pieces["distance"] 1032 | if pieces["branch"] != "master": 1033 | rendered += ".dev0" 1034 | rendered += plus_or_dot(pieces) 1035 | rendered += "g%%s" %% pieces["short"] 1036 | if pieces["dirty"]: 1037 | rendered += ".dirty" 1038 | else: 1039 | # exception #1 1040 | rendered = "0.post%%d" %% pieces["distance"] 1041 | if pieces["branch"] != "master": 1042 | rendered += ".dev0" 1043 | rendered += "+g%%s" %% pieces["short"] 1044 | if pieces["dirty"]: 1045 | rendered += ".dirty" 1046 | return rendered 1047 | 1048 | 1049 | def render_pep440_old(pieces: Dict[str, Any]) -> str: 1050 | """TAG[.postDISTANCE[.dev0]] . 1051 | 1052 | The ".dev0" means dirty. 1053 | 1054 | Exceptions: 1055 | 1: no tags. 0.postDISTANCE[.dev0] 1056 | """ 1057 | if pieces["closest-tag"]: 1058 | rendered = pieces["closest-tag"] 1059 | if pieces["distance"] or pieces["dirty"]: 1060 | rendered += ".post%%d" %% pieces["distance"] 1061 | if pieces["dirty"]: 1062 | rendered += ".dev0" 1063 | else: 1064 | # exception #1 1065 | rendered = "0.post%%d" %% pieces["distance"] 1066 | if pieces["dirty"]: 1067 | rendered += ".dev0" 1068 | return rendered 1069 | 1070 | 1071 | def render_git_describe(pieces: Dict[str, Any]) -> str: 1072 | """TAG[-DISTANCE-gHEX][-dirty]. 1073 | 1074 | Like 'git describe --tags --dirty --always'. 1075 | 1076 | Exceptions: 1077 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 1078 | """ 1079 | if pieces["closest-tag"]: 1080 | rendered = pieces["closest-tag"] 1081 | if pieces["distance"]: 1082 | rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) 1083 | else: 1084 | # exception #1 1085 | rendered = pieces["short"] 1086 | if pieces["dirty"]: 1087 | rendered += "-dirty" 1088 | return rendered 1089 | 1090 | 1091 | def render_git_describe_long(pieces: Dict[str, Any]) -> str: 1092 | """TAG-DISTANCE-gHEX[-dirty]. 1093 | 1094 | Like 'git describe --tags --dirty --always -long'. 1095 | The distance/hash is unconditional. 1096 | 1097 | Exceptions: 1098 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 1099 | """ 1100 | if pieces["closest-tag"]: 1101 | rendered = pieces["closest-tag"] 1102 | rendered += "-%%d-g%%s" %% (pieces["distance"], pieces["short"]) 1103 | else: 1104 | # exception #1 1105 | rendered = pieces["short"] 1106 | if pieces["dirty"]: 1107 | rendered += "-dirty" 1108 | return rendered 1109 | 1110 | 1111 | def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: 1112 | """Render the given version pieces into the requested style.""" 1113 | if pieces["error"]: 1114 | return {"version": "unknown", 1115 | "full-revisionid": pieces.get("long"), 1116 | "dirty": None, 1117 | "error": pieces["error"], 1118 | "date": None} 1119 | 1120 | if not style or style == "default": 1121 | style = "pep440" # the default 1122 | 1123 | if style == "pep440": 1124 | rendered = render_pep440(pieces) 1125 | elif style == "pep440-branch": 1126 | rendered = render_pep440_branch(pieces) 1127 | elif style == "pep440-pre": 1128 | rendered = render_pep440_pre(pieces) 1129 | elif style == "pep440-post": 1130 | rendered = render_pep440_post(pieces) 1131 | elif style == "pep440-post-branch": 1132 | rendered = render_pep440_post_branch(pieces) 1133 | elif style == "pep440-old": 1134 | rendered = render_pep440_old(pieces) 1135 | elif style == "git-describe": 1136 | rendered = render_git_describe(pieces) 1137 | elif style == "git-describe-long": 1138 | rendered = render_git_describe_long(pieces) 1139 | else: 1140 | raise ValueError("unknown style '%%s'" %% style) 1141 | 1142 | return {"version": rendered, "full-revisionid": pieces["long"], 1143 | "dirty": pieces["dirty"], "error": None, 1144 | "date": pieces.get("date")} 1145 | 1146 | 1147 | def get_versions() -> Dict[str, Any]: 1148 | """Get version information or return default if unable to do so.""" 1149 | # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have 1150 | # __file__, we can work backwards from there to the root. Some 1151 | # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which 1152 | # case we can only use expanded keywords. 1153 | 1154 | cfg = get_config() 1155 | verbose = cfg.verbose 1156 | 1157 | try: 1158 | return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, 1159 | verbose) 1160 | except NotThisMethod: 1161 | pass 1162 | 1163 | try: 1164 | root = os.path.realpath(__file__) 1165 | # versionfile_source is the relative path from the top of the source 1166 | # tree (where the .git directory might live) to this file. Invert 1167 | # this to find the root from __file__. 1168 | for _ in cfg.versionfile_source.split('/'): 1169 | root = os.path.dirname(root) 1170 | except NameError: 1171 | return {"version": "0+unknown", "full-revisionid": None, 1172 | "dirty": None, 1173 | "error": "unable to find root of source tree", 1174 | "date": None} 1175 | 1176 | try: 1177 | pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) 1178 | return render(pieces, cfg.style) 1179 | except NotThisMethod: 1180 | pass 1181 | 1182 | try: 1183 | if cfg.parentdir_prefix: 1184 | return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) 1185 | except NotThisMethod: 1186 | pass 1187 | 1188 | return {"version": "0+unknown", "full-revisionid": None, 1189 | "dirty": None, 1190 | "error": "unable to compute version", "date": None} 1191 | ''' 1192 | 1193 | 1194 | @register_vcs_handler("git", "get_keywords") 1195 | def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: 1196 | """Extract version information from the given file.""" 1197 | # the code embedded in _version.py can just fetch the value of these 1198 | # keywords. When used from setup.py, we don't want to import _version.py, 1199 | # so we do it with a regexp instead. This function is not used from 1200 | # _version.py. 1201 | keywords: Dict[str, str] = {} 1202 | try: 1203 | with open(versionfile_abs, "r") as fobj: 1204 | for line in fobj: 1205 | if line.strip().startswith("git_refnames ="): 1206 | mo = re.search(r'=\s*"(.*)"', line) 1207 | if mo: 1208 | keywords["refnames"] = mo.group(1) 1209 | if line.strip().startswith("git_full ="): 1210 | mo = re.search(r'=\s*"(.*)"', line) 1211 | if mo: 1212 | keywords["full"] = mo.group(1) 1213 | if line.strip().startswith("git_date ="): 1214 | mo = re.search(r'=\s*"(.*)"', line) 1215 | if mo: 1216 | keywords["date"] = mo.group(1) 1217 | except OSError: 1218 | pass 1219 | return keywords 1220 | 1221 | 1222 | @register_vcs_handler("git", "keywords") 1223 | def git_versions_from_keywords( 1224 | keywords: Dict[str, str], 1225 | tag_prefix: str, 1226 | verbose: bool, 1227 | ) -> Dict[str, Any]: 1228 | """Get version information from git keywords.""" 1229 | if "refnames" not in keywords: 1230 | raise NotThisMethod("Short version file found") 1231 | date = keywords.get("date") 1232 | if date is not None: 1233 | # Use only the last line. Previous lines may contain GPG signature 1234 | # information. 1235 | date = date.splitlines()[-1] 1236 | 1237 | # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant 1238 | # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 1239 | # -like" string, which we must then edit to make compliant), because 1240 | # it's been around since git-1.5.3, and it's too difficult to 1241 | # discover which version we're using, or to work around using an 1242 | # older one. 1243 | date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 1244 | refnames = keywords["refnames"].strip() 1245 | if refnames.startswith("$Format"): 1246 | if verbose: 1247 | print("keywords are unexpanded, not using") 1248 | raise NotThisMethod("unexpanded keywords, not a git-archive tarball") 1249 | refs = {r.strip() for r in refnames.strip("()").split(",")} 1250 | # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of 1251 | # just "foo-1.0". If we see a "tag: " prefix, prefer those. 1252 | TAG = "tag: " 1253 | tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} 1254 | if not tags: 1255 | # Either we're using git < 1.8.3, or there really are no tags. We use 1256 | # a heuristic: assume all version tags have a digit. The old git %d 1257 | # expansion behaves like git log --decorate=short and strips out the 1258 | # refs/heads/ and refs/tags/ prefixes that would let us distinguish 1259 | # between branches and tags. By ignoring refnames without digits, we 1260 | # filter out many common branch names like "release" and 1261 | # "stabilization", as well as "HEAD" and "master". 1262 | tags = {r for r in refs if re.search(r'\d', r)} 1263 | if verbose: 1264 | print("discarding '%s', no digits" % ",".join(refs - tags)) 1265 | if verbose: 1266 | print("likely tags: %s" % ",".join(sorted(tags))) 1267 | for ref in sorted(tags): 1268 | # sorting will prefer e.g. "2.0" over "2.0rc1" 1269 | if ref.startswith(tag_prefix): 1270 | r = ref[len(tag_prefix):] 1271 | # Filter out refs that exactly match prefix or that don't start 1272 | # with a number once the prefix is stripped (mostly a concern 1273 | # when prefix is '') 1274 | if not re.match(r'\d', r): 1275 | continue 1276 | if verbose: 1277 | print("picking %s" % r) 1278 | return {"version": r, 1279 | "full-revisionid": keywords["full"].strip(), 1280 | "dirty": False, "error": None, 1281 | "date": date} 1282 | # no suitable tags, so version is "0+unknown", but full hex is still there 1283 | if verbose: 1284 | print("no suitable tags, using unknown + full revision id") 1285 | return {"version": "0+unknown", 1286 | "full-revisionid": keywords["full"].strip(), 1287 | "dirty": False, "error": "no suitable tags", "date": None} 1288 | 1289 | 1290 | @register_vcs_handler("git", "pieces_from_vcs") 1291 | def git_pieces_from_vcs( 1292 | tag_prefix: str, 1293 | root: str, 1294 | verbose: bool, 1295 | runner: Callable = run_command 1296 | ) -> Dict[str, Any]: 1297 | """Get version from 'git describe' in the root of the source tree. 1298 | 1299 | This only gets called if the git-archive 'subst' keywords were *not* 1300 | expanded, and _version.py hasn't already been rewritten with a short 1301 | version string, meaning we're inside a checked out source tree. 1302 | """ 1303 | GITS = ["git"] 1304 | if sys.platform == "win32": 1305 | GITS = ["git.cmd", "git.exe"] 1306 | 1307 | # GIT_DIR can interfere with correct operation of Versioneer. 1308 | # It may be intended to be passed to the Versioneer-versioned project, 1309 | # but that should not change where we get our version from. 1310 | env = os.environ.copy() 1311 | env.pop("GIT_DIR", None) 1312 | runner = functools.partial(runner, env=env) 1313 | 1314 | _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, 1315 | hide_stderr=not verbose) 1316 | if rc != 0: 1317 | if verbose: 1318 | print("Directory %s not under git control" % root) 1319 | raise NotThisMethod("'git rev-parse --git-dir' returned error") 1320 | 1321 | # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] 1322 | # if there isn't one, this yields HEX[-dirty] (no NUM) 1323 | describe_out, rc = runner(GITS, [ 1324 | "describe", "--tags", "--dirty", "--always", "--long", 1325 | "--match", f"{tag_prefix}[[:digit:]]*" 1326 | ], cwd=root) 1327 | # --long was added in git-1.5.5 1328 | if describe_out is None: 1329 | raise NotThisMethod("'git describe' failed") 1330 | describe_out = describe_out.strip() 1331 | full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) 1332 | if full_out is None: 1333 | raise NotThisMethod("'git rev-parse' failed") 1334 | full_out = full_out.strip() 1335 | 1336 | pieces: Dict[str, Any] = {} 1337 | pieces["long"] = full_out 1338 | pieces["short"] = full_out[:7] # maybe improved later 1339 | pieces["error"] = None 1340 | 1341 | branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], 1342 | cwd=root) 1343 | # --abbrev-ref was added in git-1.6.3 1344 | if rc != 0 or branch_name is None: 1345 | raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") 1346 | branch_name = branch_name.strip() 1347 | 1348 | if branch_name == "HEAD": 1349 | # If we aren't exactly on a branch, pick a branch which represents 1350 | # the current commit. If all else fails, we are on a branchless 1351 | # commit. 1352 | branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) 1353 | # --contains was added in git-1.5.4 1354 | if rc != 0 or branches is None: 1355 | raise NotThisMethod("'git branch --contains' returned error") 1356 | branches = branches.split("\n") 1357 | 1358 | # Remove the first line if we're running detached 1359 | if "(" in branches[0]: 1360 | branches.pop(0) 1361 | 1362 | # Strip off the leading "* " from the list of branches. 1363 | branches = [branch[2:] for branch in branches] 1364 | if "master" in branches: 1365 | branch_name = "master" 1366 | elif not branches: 1367 | branch_name = None 1368 | else: 1369 | # Pick the first branch that is returned. Good or bad. 1370 | branch_name = branches[0] 1371 | 1372 | pieces["branch"] = branch_name 1373 | 1374 | # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] 1375 | # TAG might have hyphens. 1376 | git_describe = describe_out 1377 | 1378 | # look for -dirty suffix 1379 | dirty = git_describe.endswith("-dirty") 1380 | pieces["dirty"] = dirty 1381 | if dirty: 1382 | git_describe = git_describe[:git_describe.rindex("-dirty")] 1383 | 1384 | # now we have TAG-NUM-gHEX or HEX 1385 | 1386 | if "-" in git_describe: 1387 | # TAG-NUM-gHEX 1388 | mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) 1389 | if not mo: 1390 | # unparsable. Maybe git-describe is misbehaving? 1391 | pieces["error"] = ("unable to parse git-describe output: '%s'" 1392 | % describe_out) 1393 | return pieces 1394 | 1395 | # tag 1396 | full_tag = mo.group(1) 1397 | if not full_tag.startswith(tag_prefix): 1398 | if verbose: 1399 | fmt = "tag '%s' doesn't start with prefix '%s'" 1400 | print(fmt % (full_tag, tag_prefix)) 1401 | pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" 1402 | % (full_tag, tag_prefix)) 1403 | return pieces 1404 | pieces["closest-tag"] = full_tag[len(tag_prefix):] 1405 | 1406 | # distance: number of commits since tag 1407 | pieces["distance"] = int(mo.group(2)) 1408 | 1409 | # commit: short hex revision ID 1410 | pieces["short"] = mo.group(3) 1411 | 1412 | else: 1413 | # HEX: no tags 1414 | pieces["closest-tag"] = None 1415 | out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) 1416 | pieces["distance"] = len(out.split()) # total number of commits 1417 | 1418 | # commit date: see ISO-8601 comment in git_versions_from_keywords() 1419 | date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() 1420 | # Use only the last line. Previous lines may contain GPG signature 1421 | # information. 1422 | date = date.splitlines()[-1] 1423 | pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 1424 | 1425 | return pieces 1426 | 1427 | 1428 | def do_vcs_install(versionfile_source: str, ipy: Optional[str]) -> None: 1429 | """Git-specific installation logic for Versioneer. 1430 | 1431 | For Git, this means creating/changing .gitattributes to mark _version.py 1432 | for export-subst keyword substitution. 1433 | """ 1434 | GITS = ["git"] 1435 | if sys.platform == "win32": 1436 | GITS = ["git.cmd", "git.exe"] 1437 | files = [versionfile_source] 1438 | if ipy: 1439 | files.append(ipy) 1440 | if "VERSIONEER_PEP518" not in globals(): 1441 | try: 1442 | my_path = __file__ 1443 | if my_path.endswith((".pyc", ".pyo")): 1444 | my_path = os.path.splitext(my_path)[0] + ".py" 1445 | versioneer_file = os.path.relpath(my_path) 1446 | except NameError: 1447 | versioneer_file = "versioneer.py" 1448 | files.append(versioneer_file) 1449 | present = False 1450 | try: 1451 | with open(".gitattributes", "r") as fobj: 1452 | for line in fobj: 1453 | if line.strip().startswith(versionfile_source): 1454 | if "export-subst" in line.strip().split()[1:]: 1455 | present = True 1456 | break 1457 | except OSError: 1458 | pass 1459 | if not present: 1460 | with open(".gitattributes", "a+") as fobj: 1461 | fobj.write(f"{versionfile_source} export-subst\n") 1462 | files.append(".gitattributes") 1463 | run_command(GITS, ["add", "--"] + files) 1464 | 1465 | 1466 | def versions_from_parentdir( 1467 | parentdir_prefix: str, 1468 | root: str, 1469 | verbose: bool, 1470 | ) -> Dict[str, Any]: 1471 | """Try to determine the version from the parent directory name. 1472 | 1473 | Source tarballs conventionally unpack into a directory that includes both 1474 | the project name and a version string. We will also support searching up 1475 | two directory levels for an appropriately named parent directory 1476 | """ 1477 | rootdirs = [] 1478 | 1479 | for _ in range(3): 1480 | dirname = os.path.basename(root) 1481 | if dirname.startswith(parentdir_prefix): 1482 | return {"version": dirname[len(parentdir_prefix):], 1483 | "full-revisionid": None, 1484 | "dirty": False, "error": None, "date": None} 1485 | rootdirs.append(root) 1486 | root = os.path.dirname(root) # up a level 1487 | 1488 | if verbose: 1489 | print("Tried directories %s but none started with prefix %s" % 1490 | (str(rootdirs), parentdir_prefix)) 1491 | raise NotThisMethod("rootdir doesn't start with parentdir_prefix") 1492 | 1493 | 1494 | SHORT_VERSION_PY = """ 1495 | # This file was generated by 'versioneer.py' (0.29) from 1496 | # revision-control system data, or from the parent directory name of an 1497 | # unpacked source archive. Distribution tarballs contain a pre-generated copy 1498 | # of this file. 1499 | 1500 | import json 1501 | 1502 | version_json = ''' 1503 | %s 1504 | ''' # END VERSION_JSON 1505 | 1506 | 1507 | def get_versions(): 1508 | return json.loads(version_json) 1509 | """ 1510 | 1511 | 1512 | def versions_from_file(filename: str) -> Dict[str, Any]: 1513 | """Try to determine the version from _version.py if present.""" 1514 | try: 1515 | with open(filename) as f: 1516 | contents = f.read() 1517 | except OSError: 1518 | raise NotThisMethod("unable to read _version.py") 1519 | mo = re.search(r"version_json = '''\n(.*)''' # END VERSION_JSON", 1520 | contents, re.M | re.S) 1521 | if not mo: 1522 | mo = re.search(r"version_json = '''\r\n(.*)''' # END VERSION_JSON", 1523 | contents, re.M | re.S) 1524 | if not mo: 1525 | raise NotThisMethod("no version_json in _version.py") 1526 | return json.loads(mo.group(1)) 1527 | 1528 | 1529 | def write_to_version_file(filename: str, versions: Dict[str, Any]) -> None: 1530 | """Write the given version number to the given _version.py file.""" 1531 | contents = json.dumps(versions, sort_keys=True, 1532 | indent=1, separators=(",", ": ")) 1533 | with open(filename, "w") as f: 1534 | f.write(SHORT_VERSION_PY % contents) 1535 | 1536 | print("set %s to '%s'" % (filename, versions["version"])) 1537 | 1538 | 1539 | def plus_or_dot(pieces: Dict[str, Any]) -> str: 1540 | """Return a + if we don't already have one, else return a .""" 1541 | if "+" in pieces.get("closest-tag", ""): 1542 | return "." 1543 | return "+" 1544 | 1545 | 1546 | def render_pep440(pieces: Dict[str, Any]) -> str: 1547 | """Build up version string, with post-release "local version identifier". 1548 | 1549 | Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you 1550 | get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty 1551 | 1552 | Exceptions: 1553 | 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] 1554 | """ 1555 | if pieces["closest-tag"]: 1556 | rendered = pieces["closest-tag"] 1557 | if pieces["distance"] or pieces["dirty"]: 1558 | rendered += plus_or_dot(pieces) 1559 | rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) 1560 | if pieces["dirty"]: 1561 | rendered += ".dirty" 1562 | else: 1563 | # exception #1 1564 | rendered = "0+untagged.%d.g%s" % (pieces["distance"], 1565 | pieces["short"]) 1566 | if pieces["dirty"]: 1567 | rendered += ".dirty" 1568 | return rendered 1569 | 1570 | 1571 | def render_pep440_branch(pieces: Dict[str, Any]) -> str: 1572 | """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . 1573 | 1574 | The ".dev0" means not master branch. Note that .dev0 sorts backwards 1575 | (a feature branch will appear "older" than the master branch). 1576 | 1577 | Exceptions: 1578 | 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] 1579 | """ 1580 | if pieces["closest-tag"]: 1581 | rendered = pieces["closest-tag"] 1582 | if pieces["distance"] or pieces["dirty"]: 1583 | if pieces["branch"] != "master": 1584 | rendered += ".dev0" 1585 | rendered += plus_or_dot(pieces) 1586 | rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) 1587 | if pieces["dirty"]: 1588 | rendered += ".dirty" 1589 | else: 1590 | # exception #1 1591 | rendered = "0" 1592 | if pieces["branch"] != "master": 1593 | rendered += ".dev0" 1594 | rendered += "+untagged.%d.g%s" % (pieces["distance"], 1595 | pieces["short"]) 1596 | if pieces["dirty"]: 1597 | rendered += ".dirty" 1598 | return rendered 1599 | 1600 | 1601 | def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: 1602 | """Split pep440 version string at the post-release segment. 1603 | 1604 | Returns the release segments before the post-release and the 1605 | post-release version number (or -1 if no post-release segment is present). 1606 | """ 1607 | vc = str.split(ver, ".post") 1608 | return vc[0], int(vc[1] or 0) if len(vc) == 2 else None 1609 | 1610 | 1611 | def render_pep440_pre(pieces: Dict[str, Any]) -> str: 1612 | """TAG[.postN.devDISTANCE] -- No -dirty. 1613 | 1614 | Exceptions: 1615 | 1: no tags. 0.post0.devDISTANCE 1616 | """ 1617 | if pieces["closest-tag"]: 1618 | if pieces["distance"]: 1619 | # update the post release segment 1620 | tag_version, post_version = pep440_split_post(pieces["closest-tag"]) 1621 | rendered = tag_version 1622 | if post_version is not None: 1623 | rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"]) 1624 | else: 1625 | rendered += ".post0.dev%d" % (pieces["distance"]) 1626 | else: 1627 | # no commits, use the tag as the version 1628 | rendered = pieces["closest-tag"] 1629 | else: 1630 | # exception #1 1631 | rendered = "0.post0.dev%d" % pieces["distance"] 1632 | return rendered 1633 | 1634 | 1635 | def render_pep440_post(pieces: Dict[str, Any]) -> str: 1636 | """TAG[.postDISTANCE[.dev0]+gHEX] . 1637 | 1638 | The ".dev0" means dirty. Note that .dev0 sorts backwards 1639 | (a dirty tree will appear "older" than the corresponding clean one), 1640 | but you shouldn't be releasing software with -dirty anyways. 1641 | 1642 | Exceptions: 1643 | 1: no tags. 0.postDISTANCE[.dev0] 1644 | """ 1645 | if pieces["closest-tag"]: 1646 | rendered = pieces["closest-tag"] 1647 | if pieces["distance"] or pieces["dirty"]: 1648 | rendered += ".post%d" % pieces["distance"] 1649 | if pieces["dirty"]: 1650 | rendered += ".dev0" 1651 | rendered += plus_or_dot(pieces) 1652 | rendered += "g%s" % pieces["short"] 1653 | else: 1654 | # exception #1 1655 | rendered = "0.post%d" % pieces["distance"] 1656 | if pieces["dirty"]: 1657 | rendered += ".dev0" 1658 | rendered += "+g%s" % pieces["short"] 1659 | return rendered 1660 | 1661 | 1662 | def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: 1663 | """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . 1664 | 1665 | The ".dev0" means not master branch. 1666 | 1667 | Exceptions: 1668 | 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] 1669 | """ 1670 | if pieces["closest-tag"]: 1671 | rendered = pieces["closest-tag"] 1672 | if pieces["distance"] or pieces["dirty"]: 1673 | rendered += ".post%d" % pieces["distance"] 1674 | if pieces["branch"] != "master": 1675 | rendered += ".dev0" 1676 | rendered += plus_or_dot(pieces) 1677 | rendered += "g%s" % pieces["short"] 1678 | if pieces["dirty"]: 1679 | rendered += ".dirty" 1680 | else: 1681 | # exception #1 1682 | rendered = "0.post%d" % pieces["distance"] 1683 | if pieces["branch"] != "master": 1684 | rendered += ".dev0" 1685 | rendered += "+g%s" % pieces["short"] 1686 | if pieces["dirty"]: 1687 | rendered += ".dirty" 1688 | return rendered 1689 | 1690 | 1691 | def render_pep440_old(pieces: Dict[str, Any]) -> str: 1692 | """TAG[.postDISTANCE[.dev0]] . 1693 | 1694 | The ".dev0" means dirty. 1695 | 1696 | Exceptions: 1697 | 1: no tags. 0.postDISTANCE[.dev0] 1698 | """ 1699 | if pieces["closest-tag"]: 1700 | rendered = pieces["closest-tag"] 1701 | if pieces["distance"] or pieces["dirty"]: 1702 | rendered += ".post%d" % pieces["distance"] 1703 | if pieces["dirty"]: 1704 | rendered += ".dev0" 1705 | else: 1706 | # exception #1 1707 | rendered = "0.post%d" % pieces["distance"] 1708 | if pieces["dirty"]: 1709 | rendered += ".dev0" 1710 | return rendered 1711 | 1712 | 1713 | def render_git_describe(pieces: Dict[str, Any]) -> str: 1714 | """TAG[-DISTANCE-gHEX][-dirty]. 1715 | 1716 | Like 'git describe --tags --dirty --always'. 1717 | 1718 | Exceptions: 1719 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 1720 | """ 1721 | if pieces["closest-tag"]: 1722 | rendered = pieces["closest-tag"] 1723 | if pieces["distance"]: 1724 | rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) 1725 | else: 1726 | # exception #1 1727 | rendered = pieces["short"] 1728 | if pieces["dirty"]: 1729 | rendered += "-dirty" 1730 | return rendered 1731 | 1732 | 1733 | def render_git_describe_long(pieces: Dict[str, Any]) -> str: 1734 | """TAG-DISTANCE-gHEX[-dirty]. 1735 | 1736 | Like 'git describe --tags --dirty --always -long'. 1737 | The distance/hash is unconditional. 1738 | 1739 | Exceptions: 1740 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 1741 | """ 1742 | if pieces["closest-tag"]: 1743 | rendered = pieces["closest-tag"] 1744 | rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) 1745 | else: 1746 | # exception #1 1747 | rendered = pieces["short"] 1748 | if pieces["dirty"]: 1749 | rendered += "-dirty" 1750 | return rendered 1751 | 1752 | 1753 | def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: 1754 | """Render the given version pieces into the requested style.""" 1755 | if pieces["error"]: 1756 | return {"version": "unknown", 1757 | "full-revisionid": pieces.get("long"), 1758 | "dirty": None, 1759 | "error": pieces["error"], 1760 | "date": None} 1761 | 1762 | if not style or style == "default": 1763 | style = "pep440" # the default 1764 | 1765 | if style == "pep440": 1766 | rendered = render_pep440(pieces) 1767 | elif style == "pep440-branch": 1768 | rendered = render_pep440_branch(pieces) 1769 | elif style == "pep440-pre": 1770 | rendered = render_pep440_pre(pieces) 1771 | elif style == "pep440-post": 1772 | rendered = render_pep440_post(pieces) 1773 | elif style == "pep440-post-branch": 1774 | rendered = render_pep440_post_branch(pieces) 1775 | elif style == "pep440-old": 1776 | rendered = render_pep440_old(pieces) 1777 | elif style == "git-describe": 1778 | rendered = render_git_describe(pieces) 1779 | elif style == "git-describe-long": 1780 | rendered = render_git_describe_long(pieces) 1781 | else: 1782 | raise ValueError("unknown style '%s'" % style) 1783 | 1784 | return {"version": rendered, "full-revisionid": pieces["long"], 1785 | "dirty": pieces["dirty"], "error": None, 1786 | "date": pieces.get("date")} 1787 | 1788 | 1789 | class VersioneerBadRootError(Exception): 1790 | """The project root directory is unknown or missing key files.""" 1791 | 1792 | 1793 | def get_versions(verbose: bool = False) -> Dict[str, Any]: 1794 | """Get the project version from whatever source is available. 1795 | 1796 | Returns dict with two keys: 'version' and 'full'. 1797 | """ 1798 | if "versioneer" in sys.modules: 1799 | # see the discussion in cmdclass.py:get_cmdclass() 1800 | del sys.modules["versioneer"] 1801 | 1802 | root = get_root() 1803 | cfg = get_config_from_root(root) 1804 | 1805 | assert cfg.VCS is not None, "please set [versioneer]VCS= in setup.cfg" 1806 | handlers = HANDLERS.get(cfg.VCS) 1807 | assert handlers, "unrecognized VCS '%s'" % cfg.VCS 1808 | verbose = verbose or bool(cfg.verbose) # `bool()` used to avoid `None` 1809 | assert cfg.versionfile_source is not None, \ 1810 | "please set versioneer.versionfile_source" 1811 | assert cfg.tag_prefix is not None, "please set versioneer.tag_prefix" 1812 | 1813 | versionfile_abs = os.path.join(root, cfg.versionfile_source) 1814 | 1815 | # extract version from first of: _version.py, VCS command (e.g. 'git 1816 | # describe'), parentdir. This is meant to work for developers using a 1817 | # source checkout, for users of a tarball created by 'setup.py sdist', 1818 | # and for users of a tarball/zipball created by 'git archive' or github's 1819 | # download-from-tag feature or the equivalent in other VCSes. 1820 | 1821 | get_keywords_f = handlers.get("get_keywords") 1822 | from_keywords_f = handlers.get("keywords") 1823 | if get_keywords_f and from_keywords_f: 1824 | try: 1825 | keywords = get_keywords_f(versionfile_abs) 1826 | ver = from_keywords_f(keywords, cfg.tag_prefix, verbose) 1827 | if verbose: 1828 | print("got version from expanded keyword %s" % ver) 1829 | return ver 1830 | except NotThisMethod: 1831 | pass 1832 | 1833 | try: 1834 | ver = versions_from_file(versionfile_abs) 1835 | if verbose: 1836 | print("got version from file %s %s" % (versionfile_abs, ver)) 1837 | return ver 1838 | except NotThisMethod: 1839 | pass 1840 | 1841 | from_vcs_f = handlers.get("pieces_from_vcs") 1842 | if from_vcs_f: 1843 | try: 1844 | pieces = from_vcs_f(cfg.tag_prefix, root, verbose) 1845 | ver = render(pieces, cfg.style) 1846 | if verbose: 1847 | print("got version from VCS %s" % ver) 1848 | return ver 1849 | except NotThisMethod: 1850 | pass 1851 | 1852 | try: 1853 | if cfg.parentdir_prefix: 1854 | ver = versions_from_parentdir(cfg.parentdir_prefix, root, verbose) 1855 | if verbose: 1856 | print("got version from parentdir %s" % ver) 1857 | return ver 1858 | except NotThisMethod: 1859 | pass 1860 | 1861 | if verbose: 1862 | print("unable to compute version") 1863 | 1864 | return {"version": "0+unknown", "full-revisionid": None, 1865 | "dirty": None, "error": "unable to compute version", 1866 | "date": None} 1867 | 1868 | 1869 | def get_version() -> str: 1870 | """Get the short version string for this project.""" 1871 | return get_versions()["version"] 1872 | 1873 | 1874 | def get_cmdclass(cmdclass: Optional[Dict[str, Any]] = None): 1875 | """Get the custom setuptools subclasses used by Versioneer. 1876 | 1877 | If the package uses a different cmdclass (e.g. one from numpy), it 1878 | should be provide as an argument. 1879 | """ 1880 | if "versioneer" in sys.modules: 1881 | del sys.modules["versioneer"] 1882 | # this fixes the "python setup.py develop" case (also 'install' and 1883 | # 'easy_install .'), in which subdependencies of the main project are 1884 | # built (using setup.py bdist_egg) in the same python process. Assume 1885 | # a main project A and a dependency B, which use different versions 1886 | # of Versioneer. A's setup.py imports A's Versioneer, leaving it in 1887 | # sys.modules by the time B's setup.py is executed, causing B to run 1888 | # with the wrong versioneer. Setuptools wraps the sub-dep builds in a 1889 | # sandbox that restores sys.modules to it's pre-build state, so the 1890 | # parent is protected against the child's "import versioneer". By 1891 | # removing ourselves from sys.modules here, before the child build 1892 | # happens, we protect the child from the parent's versioneer too. 1893 | # Also see https://github.com/python-versioneer/python-versioneer/issues/52 1894 | 1895 | cmds = {} if cmdclass is None else cmdclass.copy() 1896 | 1897 | # we add "version" to setuptools 1898 | from setuptools import Command 1899 | 1900 | class cmd_version(Command): 1901 | description = "report generated version string" 1902 | user_options: List[Tuple[str, str, str]] = [] 1903 | boolean_options: List[str] = [] 1904 | 1905 | def initialize_options(self) -> None: 1906 | pass 1907 | 1908 | def finalize_options(self) -> None: 1909 | pass 1910 | 1911 | def run(self) -> None: 1912 | vers = get_versions(verbose=True) 1913 | print("Version: %s" % vers["version"]) 1914 | print(" full-revisionid: %s" % vers.get("full-revisionid")) 1915 | print(" dirty: %s" % vers.get("dirty")) 1916 | print(" date: %s" % vers.get("date")) 1917 | if vers["error"]: 1918 | print(" error: %s" % vers["error"]) 1919 | cmds["version"] = cmd_version 1920 | 1921 | # we override "build_py" in setuptools 1922 | # 1923 | # most invocation pathways end up running build_py: 1924 | # distutils/build -> build_py 1925 | # distutils/install -> distutils/build ->.. 1926 | # setuptools/bdist_wheel -> distutils/install ->.. 1927 | # setuptools/bdist_egg -> distutils/install_lib -> build_py 1928 | # setuptools/install -> bdist_egg ->.. 1929 | # setuptools/develop -> ? 1930 | # pip install: 1931 | # copies source tree to a tempdir before running egg_info/etc 1932 | # if .git isn't copied too, 'git describe' will fail 1933 | # then does setup.py bdist_wheel, or sometimes setup.py install 1934 | # setup.py egg_info -> ? 1935 | 1936 | # pip install -e . and setuptool/editable_wheel will invoke build_py 1937 | # but the build_py command is not expected to copy any files. 1938 | 1939 | # we override different "build_py" commands for both environments 1940 | if 'build_py' in cmds: 1941 | _build_py: Any = cmds['build_py'] 1942 | else: 1943 | from setuptools.command.build_py import build_py as _build_py 1944 | 1945 | class cmd_build_py(_build_py): 1946 | def run(self) -> None: 1947 | root = get_root() 1948 | cfg = get_config_from_root(root) 1949 | versions = get_versions() 1950 | _build_py.run(self) 1951 | if getattr(self, "editable_mode", False): 1952 | # During editable installs `.py` and data files are 1953 | # not copied to build_lib 1954 | return 1955 | # now locate _version.py in the new build/ directory and replace 1956 | # it with an updated value 1957 | if cfg.versionfile_build: 1958 | target_versionfile = os.path.join(self.build_lib, 1959 | cfg.versionfile_build) 1960 | print("UPDATING %s" % target_versionfile) 1961 | write_to_version_file(target_versionfile, versions) 1962 | cmds["build_py"] = cmd_build_py 1963 | 1964 | if 'build_ext' in cmds: 1965 | _build_ext: Any = cmds['build_ext'] 1966 | else: 1967 | from setuptools.command.build_ext import build_ext as _build_ext 1968 | 1969 | class cmd_build_ext(_build_ext): 1970 | def run(self) -> None: 1971 | root = get_root() 1972 | cfg = get_config_from_root(root) 1973 | versions = get_versions() 1974 | _build_ext.run(self) 1975 | if self.inplace: 1976 | # build_ext --inplace will only build extensions in 1977 | # build/lib<..> dir with no _version.py to write to. 1978 | # As in place builds will already have a _version.py 1979 | # in the module dir, we do not need to write one. 1980 | return 1981 | # now locate _version.py in the new build/ directory and replace 1982 | # it with an updated value 1983 | if not cfg.versionfile_build: 1984 | return 1985 | target_versionfile = os.path.join(self.build_lib, 1986 | cfg.versionfile_build) 1987 | if not os.path.exists(target_versionfile): 1988 | print(f"Warning: {target_versionfile} does not exist, skipping " 1989 | "version update. This can happen if you are running build_ext " 1990 | "without first running build_py.") 1991 | return 1992 | print("UPDATING %s" % target_versionfile) 1993 | write_to_version_file(target_versionfile, versions) 1994 | cmds["build_ext"] = cmd_build_ext 1995 | 1996 | if "cx_Freeze" in sys.modules: # cx_freeze enabled? 1997 | from cx_Freeze.dist import build_exe as _build_exe # type: ignore 1998 | # nczeczulin reports that py2exe won't like the pep440-style string 1999 | # as FILEVERSION, but it can be used for PRODUCTVERSION, e.g. 2000 | # setup(console=[{ 2001 | # "version": versioneer.get_version().split("+", 1)[0], # FILEVERSION 2002 | # "product_version": versioneer.get_version(), 2003 | # ... 2004 | 2005 | class cmd_build_exe(_build_exe): 2006 | def run(self) -> None: 2007 | root = get_root() 2008 | cfg = get_config_from_root(root) 2009 | versions = get_versions() 2010 | target_versionfile = cfg.versionfile_source 2011 | print("UPDATING %s" % target_versionfile) 2012 | write_to_version_file(target_versionfile, versions) 2013 | 2014 | _build_exe.run(self) 2015 | os.unlink(target_versionfile) 2016 | with open(cfg.versionfile_source, "w") as f: 2017 | LONG = LONG_VERSION_PY[cfg.VCS] 2018 | f.write(LONG % 2019 | {"DOLLAR": "$", 2020 | "STYLE": cfg.style, 2021 | "TAG_PREFIX": cfg.tag_prefix, 2022 | "PARENTDIR_PREFIX": cfg.parentdir_prefix, 2023 | "VERSIONFILE_SOURCE": cfg.versionfile_source, 2024 | }) 2025 | cmds["build_exe"] = cmd_build_exe 2026 | del cmds["build_py"] 2027 | 2028 | if 'py2exe' in sys.modules: # py2exe enabled? 2029 | try: 2030 | from py2exe.setuptools_buildexe import py2exe as _py2exe # type: ignore 2031 | except ImportError: 2032 | from py2exe.distutils_buildexe import py2exe as _py2exe # type: ignore 2033 | 2034 | class cmd_py2exe(_py2exe): 2035 | def run(self) -> None: 2036 | root = get_root() 2037 | cfg = get_config_from_root(root) 2038 | versions = get_versions() 2039 | target_versionfile = cfg.versionfile_source 2040 | print("UPDATING %s" % target_versionfile) 2041 | write_to_version_file(target_versionfile, versions) 2042 | 2043 | _py2exe.run(self) 2044 | os.unlink(target_versionfile) 2045 | with open(cfg.versionfile_source, "w") as f: 2046 | LONG = LONG_VERSION_PY[cfg.VCS] 2047 | f.write(LONG % 2048 | {"DOLLAR": "$", 2049 | "STYLE": cfg.style, 2050 | "TAG_PREFIX": cfg.tag_prefix, 2051 | "PARENTDIR_PREFIX": cfg.parentdir_prefix, 2052 | "VERSIONFILE_SOURCE": cfg.versionfile_source, 2053 | }) 2054 | cmds["py2exe"] = cmd_py2exe 2055 | 2056 | # sdist farms its file list building out to egg_info 2057 | if 'egg_info' in cmds: 2058 | _egg_info: Any = cmds['egg_info'] 2059 | else: 2060 | from setuptools.command.egg_info import egg_info as _egg_info 2061 | 2062 | class cmd_egg_info(_egg_info): 2063 | def find_sources(self) -> None: 2064 | # egg_info.find_sources builds the manifest list and writes it 2065 | # in one shot 2066 | super().find_sources() 2067 | 2068 | # Modify the filelist and normalize it 2069 | root = get_root() 2070 | cfg = get_config_from_root(root) 2071 | self.filelist.append('versioneer.py') 2072 | if cfg.versionfile_source: 2073 | # There are rare cases where versionfile_source might not be 2074 | # included by default, so we must be explicit 2075 | self.filelist.append(cfg.versionfile_source) 2076 | self.filelist.sort() 2077 | self.filelist.remove_duplicates() 2078 | 2079 | # The write method is hidden in the manifest_maker instance that 2080 | # generated the filelist and was thrown away 2081 | # We will instead replicate their final normalization (to unicode, 2082 | # and POSIX-style paths) 2083 | from setuptools import unicode_utils 2084 | normalized = [unicode_utils.filesys_decode(f).replace(os.sep, '/') 2085 | for f in self.filelist.files] 2086 | 2087 | manifest_filename = os.path.join(self.egg_info, 'SOURCES.txt') 2088 | with open(manifest_filename, 'w') as fobj: 2089 | fobj.write('\n'.join(normalized)) 2090 | 2091 | cmds['egg_info'] = cmd_egg_info 2092 | 2093 | # we override different "sdist" commands for both environments 2094 | if 'sdist' in cmds: 2095 | _sdist: Any = cmds['sdist'] 2096 | else: 2097 | from setuptools.command.sdist import sdist as _sdist 2098 | 2099 | class cmd_sdist(_sdist): 2100 | def run(self) -> None: 2101 | versions = get_versions() 2102 | self._versioneer_generated_versions = versions 2103 | # unless we update this, the command will keep using the old 2104 | # version 2105 | self.distribution.metadata.version = versions["version"] 2106 | return _sdist.run(self) 2107 | 2108 | def make_release_tree(self, base_dir: str, files: List[str]) -> None: 2109 | root = get_root() 2110 | cfg = get_config_from_root(root) 2111 | _sdist.make_release_tree(self, base_dir, files) 2112 | # now locate _version.py in the new base_dir directory 2113 | # (remembering that it may be a hardlink) and replace it with an 2114 | # updated value 2115 | target_versionfile = os.path.join(base_dir, cfg.versionfile_source) 2116 | print("UPDATING %s" % target_versionfile) 2117 | write_to_version_file(target_versionfile, 2118 | self._versioneer_generated_versions) 2119 | cmds["sdist"] = cmd_sdist 2120 | 2121 | return cmds 2122 | 2123 | 2124 | CONFIG_ERROR = """ 2125 | setup.cfg is missing the necessary Versioneer configuration. You need 2126 | a section like: 2127 | 2128 | [versioneer] 2129 | VCS = git 2130 | style = pep440 2131 | versionfile_source = src/myproject/_version.py 2132 | versionfile_build = myproject/_version.py 2133 | tag_prefix = 2134 | parentdir_prefix = myproject- 2135 | 2136 | You will also need to edit your setup.py to use the results: 2137 | 2138 | import versioneer 2139 | setup(version=versioneer.get_version(), 2140 | cmdclass=versioneer.get_cmdclass(), ...) 2141 | 2142 | Please read the docstring in ./versioneer.py for configuration instructions, 2143 | edit setup.cfg, and re-run the installer or 'python versioneer.py setup'. 2144 | """ 2145 | 2146 | SAMPLE_CONFIG = """ 2147 | # See the docstring in versioneer.py for instructions. Note that you must 2148 | # re-run 'versioneer.py setup' after changing this section, and commit the 2149 | # resulting files. 2150 | 2151 | [versioneer] 2152 | #VCS = git 2153 | #style = pep440 2154 | #versionfile_source = 2155 | #versionfile_build = 2156 | #tag_prefix = 2157 | #parentdir_prefix = 2158 | 2159 | """ 2160 | 2161 | OLD_SNIPPET = """ 2162 | from ._version import get_versions 2163 | __version__ = get_versions()['version'] 2164 | del get_versions 2165 | """ 2166 | 2167 | INIT_PY_SNIPPET = """ 2168 | from . import {0} 2169 | __version__ = {0}.get_versions()['version'] 2170 | """ 2171 | 2172 | 2173 | def do_setup() -> int: 2174 | """Do main VCS-independent setup function for installing Versioneer.""" 2175 | root = get_root() 2176 | try: 2177 | cfg = get_config_from_root(root) 2178 | except (OSError, configparser.NoSectionError, 2179 | configparser.NoOptionError) as e: 2180 | if isinstance(e, (OSError, configparser.NoSectionError)): 2181 | print("Adding sample versioneer config to setup.cfg", 2182 | file=sys.stderr) 2183 | with open(os.path.join(root, "setup.cfg"), "a") as f: 2184 | f.write(SAMPLE_CONFIG) 2185 | print(CONFIG_ERROR, file=sys.stderr) 2186 | return 1 2187 | 2188 | print(" creating %s" % cfg.versionfile_source) 2189 | with open(cfg.versionfile_source, "w") as f: 2190 | LONG = LONG_VERSION_PY[cfg.VCS] 2191 | f.write(LONG % {"DOLLAR": "$", 2192 | "STYLE": cfg.style, 2193 | "TAG_PREFIX": cfg.tag_prefix, 2194 | "PARENTDIR_PREFIX": cfg.parentdir_prefix, 2195 | "VERSIONFILE_SOURCE": cfg.versionfile_source, 2196 | }) 2197 | 2198 | ipy = os.path.join(os.path.dirname(cfg.versionfile_source), 2199 | "__init__.py") 2200 | maybe_ipy: Optional[str] = ipy 2201 | if os.path.exists(ipy): 2202 | try: 2203 | with open(ipy, "r") as f: 2204 | old = f.read() 2205 | except OSError: 2206 | old = "" 2207 | module = os.path.splitext(os.path.basename(cfg.versionfile_source))[0] 2208 | snippet = INIT_PY_SNIPPET.format(module) 2209 | if OLD_SNIPPET in old: 2210 | print(" replacing boilerplate in %s" % ipy) 2211 | with open(ipy, "w") as f: 2212 | f.write(old.replace(OLD_SNIPPET, snippet)) 2213 | elif snippet not in old: 2214 | print(" appending to %s" % ipy) 2215 | with open(ipy, "a") as f: 2216 | f.write(snippet) 2217 | else: 2218 | print(" %s unmodified" % ipy) 2219 | else: 2220 | print(" %s doesn't exist, ok" % ipy) 2221 | maybe_ipy = None 2222 | 2223 | # Make VCS-specific changes. For git, this means creating/changing 2224 | # .gitattributes to mark _version.py for export-subst keyword 2225 | # substitution. 2226 | do_vcs_install(cfg.versionfile_source, maybe_ipy) 2227 | return 0 2228 | 2229 | 2230 | def scan_setup_py() -> int: 2231 | """Validate the contents of setup.py against Versioneer's expectations.""" 2232 | found = set() 2233 | setters = False 2234 | errors = 0 2235 | with open("setup.py", "r") as f: 2236 | for line in f.readlines(): 2237 | if "import versioneer" in line: 2238 | found.add("import") 2239 | if "versioneer.get_cmdclass()" in line: 2240 | found.add("cmdclass") 2241 | if "versioneer.get_version()" in line: 2242 | found.add("get_version") 2243 | if "versioneer.VCS" in line: 2244 | setters = True 2245 | if "versioneer.versionfile_source" in line: 2246 | setters = True 2247 | if len(found) != 3: 2248 | print("") 2249 | print("Your setup.py appears to be missing some important items") 2250 | print("(but I might be wrong). Please make sure it has something") 2251 | print("roughly like the following:") 2252 | print("") 2253 | print(" import versioneer") 2254 | print(" setup( version=versioneer.get_version(),") 2255 | print(" cmdclass=versioneer.get_cmdclass(), ...)") 2256 | print("") 2257 | errors += 1 2258 | if setters: 2259 | print("You should remove lines like 'versioneer.VCS = ' and") 2260 | print("'versioneer.versionfile_source = ' . This configuration") 2261 | print("now lives in setup.cfg, and should be removed from setup.py") 2262 | print("") 2263 | errors += 1 2264 | return errors 2265 | 2266 | 2267 | def setup_command() -> NoReturn: 2268 | """Set up Versioneer and exit with appropriate error code.""" 2269 | errors = do_setup() 2270 | errors += scan_setup_py() 2271 | sys.exit(1 if errors else 0) 2272 | 2273 | 2274 | if __name__ == "__main__": 2275 | cmd = sys.argv[1] 2276 | if cmd == "setup": 2277 | setup_command() 2278 | -------------------------------------------------------------------------------- /xff/__init__.py: -------------------------------------------------------------------------------- 1 | 2 | from . import _version 3 | __version__ = _version.get_versions()['version'] 4 | -------------------------------------------------------------------------------- /xff/_version.py: -------------------------------------------------------------------------------- 1 | 2 | # This file helps to compute a version number in source trees obtained from 3 | # git-archive tarball (such as those provided by githubs download-from-tag 4 | # feature). Distribution tarballs (built by setup.py sdist) and build 5 | # directories (produced by setup.py build) will contain a much shorter file 6 | # that just contains the computed version number. 7 | 8 | # This file is released into the public domain. 9 | # Generated by versioneer-0.29 10 | # https://github.com/python-versioneer/python-versioneer 11 | 12 | """Git implementation of _version.py.""" 13 | 14 | import errno 15 | import os 16 | import re 17 | import subprocess 18 | import sys 19 | from typing import Any, Callable, Dict, List, Optional, Tuple 20 | import functools 21 | 22 | 23 | def get_keywords() -> Dict[str, str]: 24 | """Get the keywords needed to look up the version information.""" 25 | # these strings will be replaced by git during git-archive. 26 | # setup.py/versioneer.py will grep for the variable names, so they must 27 | # each be defined on a line of their own. _version.py will just call 28 | # get_keywords(). 29 | git_refnames = " (HEAD -> master, tag: 1.5.0)" 30 | git_full = "df194b221e7f9f4b6f748e437be084ef4e41dc83" 31 | git_date = "2025-02-13 22:48:30 +0200" 32 | keywords = {"refnames": git_refnames, "full": git_full, "date": git_date} 33 | return keywords 34 | 35 | 36 | class VersioneerConfig: 37 | """Container for Versioneer configuration parameters.""" 38 | 39 | VCS: str 40 | style: str 41 | tag_prefix: str 42 | parentdir_prefix: str 43 | versionfile_source: str 44 | verbose: bool 45 | 46 | 47 | def get_config() -> VersioneerConfig: 48 | """Create, populate and return the VersioneerConfig() object.""" 49 | # these strings are filled in when 'setup.py versioneer' creates 50 | # _version.py 51 | cfg = VersioneerConfig() 52 | cfg.VCS = "git" 53 | cfg.style = "pep440" 54 | cfg.tag_prefix = "" 55 | cfg.parentdir_prefix = "xff-" 56 | cfg.versionfile_source = "xff/_version.py" 57 | cfg.verbose = False 58 | return cfg 59 | 60 | 61 | class NotThisMethod(Exception): 62 | """Exception raised if a method is not valid for the current scenario.""" 63 | 64 | 65 | LONG_VERSION_PY: Dict[str, str] = {} 66 | HANDLERS: Dict[str, Dict[str, Callable]] = {} 67 | 68 | 69 | def register_vcs_handler(vcs: str, method: str) -> Callable: # decorator 70 | """Create decorator to mark a method as the handler of a VCS.""" 71 | def decorate(f: Callable) -> Callable: 72 | """Store f in HANDLERS[vcs][method].""" 73 | if vcs not in HANDLERS: 74 | HANDLERS[vcs] = {} 75 | HANDLERS[vcs][method] = f 76 | return f 77 | return decorate 78 | 79 | 80 | def run_command( 81 | commands: List[str], 82 | args: List[str], 83 | cwd: Optional[str] = None, 84 | verbose: bool = False, 85 | hide_stderr: bool = False, 86 | env: Optional[Dict[str, str]] = None, 87 | ) -> Tuple[Optional[str], Optional[int]]: 88 | """Call the given command(s).""" 89 | assert isinstance(commands, list) 90 | process = None 91 | 92 | popen_kwargs: Dict[str, Any] = {} 93 | if sys.platform == "win32": 94 | # This hides the console window if pythonw.exe is used 95 | startupinfo = subprocess.STARTUPINFO() 96 | startupinfo.dwFlags |= subprocess.STARTF_USESHOWWINDOW 97 | popen_kwargs["startupinfo"] = startupinfo 98 | 99 | for command in commands: 100 | try: 101 | dispcmd = str([command] + args) 102 | # remember shell=False, so use git.cmd on windows, not just git 103 | process = subprocess.Popen([command] + args, cwd=cwd, env=env, 104 | stdout=subprocess.PIPE, 105 | stderr=(subprocess.PIPE if hide_stderr 106 | else None), **popen_kwargs) 107 | break 108 | except OSError as e: 109 | if e.errno == errno.ENOENT: 110 | continue 111 | if verbose: 112 | print("unable to run %s" % dispcmd) 113 | print(e) 114 | return None, None 115 | else: 116 | if verbose: 117 | print("unable to find command, tried %s" % (commands,)) 118 | return None, None 119 | stdout = process.communicate()[0].strip().decode() 120 | if process.returncode != 0: 121 | if verbose: 122 | print("unable to run %s (error)" % dispcmd) 123 | print("stdout was %s" % stdout) 124 | return None, process.returncode 125 | return stdout, process.returncode 126 | 127 | 128 | def versions_from_parentdir( 129 | parentdir_prefix: str, 130 | root: str, 131 | verbose: bool, 132 | ) -> Dict[str, Any]: 133 | """Try to determine the version from the parent directory name. 134 | 135 | Source tarballs conventionally unpack into a directory that includes both 136 | the project name and a version string. We will also support searching up 137 | two directory levels for an appropriately named parent directory 138 | """ 139 | rootdirs = [] 140 | 141 | for _ in range(3): 142 | dirname = os.path.basename(root) 143 | if dirname.startswith(parentdir_prefix): 144 | return {"version": dirname[len(parentdir_prefix):], 145 | "full-revisionid": None, 146 | "dirty": False, "error": None, "date": None} 147 | rootdirs.append(root) 148 | root = os.path.dirname(root) # up a level 149 | 150 | if verbose: 151 | print("Tried directories %s but none started with prefix %s" % 152 | (str(rootdirs), parentdir_prefix)) 153 | raise NotThisMethod("rootdir doesn't start with parentdir_prefix") 154 | 155 | 156 | @register_vcs_handler("git", "get_keywords") 157 | def git_get_keywords(versionfile_abs: str) -> Dict[str, str]: 158 | """Extract version information from the given file.""" 159 | # the code embedded in _version.py can just fetch the value of these 160 | # keywords. When used from setup.py, we don't want to import _version.py, 161 | # so we do it with a regexp instead. This function is not used from 162 | # _version.py. 163 | keywords: Dict[str, str] = {} 164 | try: 165 | with open(versionfile_abs, "r") as fobj: 166 | for line in fobj: 167 | if line.strip().startswith("git_refnames ="): 168 | mo = re.search(r'=\s*"(.*)"', line) 169 | if mo: 170 | keywords["refnames"] = mo.group(1) 171 | if line.strip().startswith("git_full ="): 172 | mo = re.search(r'=\s*"(.*)"', line) 173 | if mo: 174 | keywords["full"] = mo.group(1) 175 | if line.strip().startswith("git_date ="): 176 | mo = re.search(r'=\s*"(.*)"', line) 177 | if mo: 178 | keywords["date"] = mo.group(1) 179 | except OSError: 180 | pass 181 | return keywords 182 | 183 | 184 | @register_vcs_handler("git", "keywords") 185 | def git_versions_from_keywords( 186 | keywords: Dict[str, str], 187 | tag_prefix: str, 188 | verbose: bool, 189 | ) -> Dict[str, Any]: 190 | """Get version information from git keywords.""" 191 | if "refnames" not in keywords: 192 | raise NotThisMethod("Short version file found") 193 | date = keywords.get("date") 194 | if date is not None: 195 | # Use only the last line. Previous lines may contain GPG signature 196 | # information. 197 | date = date.splitlines()[-1] 198 | 199 | # git-2.2.0 added "%cI", which expands to an ISO-8601 -compliant 200 | # datestamp. However we prefer "%ci" (which expands to an "ISO-8601 201 | # -like" string, which we must then edit to make compliant), because 202 | # it's been around since git-1.5.3, and it's too difficult to 203 | # discover which version we're using, or to work around using an 204 | # older one. 205 | date = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 206 | refnames = keywords["refnames"].strip() 207 | if refnames.startswith("$Format"): 208 | if verbose: 209 | print("keywords are unexpanded, not using") 210 | raise NotThisMethod("unexpanded keywords, not a git-archive tarball") 211 | refs = {r.strip() for r in refnames.strip("()").split(",")} 212 | # starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of 213 | # just "foo-1.0". If we see a "tag: " prefix, prefer those. 214 | TAG = "tag: " 215 | tags = {r[len(TAG):] for r in refs if r.startswith(TAG)} 216 | if not tags: 217 | # Either we're using git < 1.8.3, or there really are no tags. We use 218 | # a heuristic: assume all version tags have a digit. The old git %d 219 | # expansion behaves like git log --decorate=short and strips out the 220 | # refs/heads/ and refs/tags/ prefixes that would let us distinguish 221 | # between branches and tags. By ignoring refnames without digits, we 222 | # filter out many common branch names like "release" and 223 | # "stabilization", as well as "HEAD" and "master". 224 | tags = {r for r in refs if re.search(r'\d', r)} 225 | if verbose: 226 | print("discarding '%s', no digits" % ",".join(refs - tags)) 227 | if verbose: 228 | print("likely tags: %s" % ",".join(sorted(tags))) 229 | for ref in sorted(tags): 230 | # sorting will prefer e.g. "2.0" over "2.0rc1" 231 | if ref.startswith(tag_prefix): 232 | r = ref[len(tag_prefix):] 233 | # Filter out refs that exactly match prefix or that don't start 234 | # with a number once the prefix is stripped (mostly a concern 235 | # when prefix is '') 236 | if not re.match(r'\d', r): 237 | continue 238 | if verbose: 239 | print("picking %s" % r) 240 | return {"version": r, 241 | "full-revisionid": keywords["full"].strip(), 242 | "dirty": False, "error": None, 243 | "date": date} 244 | # no suitable tags, so version is "0+unknown", but full hex is still there 245 | if verbose: 246 | print("no suitable tags, using unknown + full revision id") 247 | return {"version": "0+unknown", 248 | "full-revisionid": keywords["full"].strip(), 249 | "dirty": False, "error": "no suitable tags", "date": None} 250 | 251 | 252 | @register_vcs_handler("git", "pieces_from_vcs") 253 | def git_pieces_from_vcs( 254 | tag_prefix: str, 255 | root: str, 256 | verbose: bool, 257 | runner: Callable = run_command 258 | ) -> Dict[str, Any]: 259 | """Get version from 'git describe' in the root of the source tree. 260 | 261 | This only gets called if the git-archive 'subst' keywords were *not* 262 | expanded, and _version.py hasn't already been rewritten with a short 263 | version string, meaning we're inside a checked out source tree. 264 | """ 265 | GITS = ["git"] 266 | if sys.platform == "win32": 267 | GITS = ["git.cmd", "git.exe"] 268 | 269 | # GIT_DIR can interfere with correct operation of Versioneer. 270 | # It may be intended to be passed to the Versioneer-versioned project, 271 | # but that should not change where we get our version from. 272 | env = os.environ.copy() 273 | env.pop("GIT_DIR", None) 274 | runner = functools.partial(runner, env=env) 275 | 276 | _, rc = runner(GITS, ["rev-parse", "--git-dir"], cwd=root, 277 | hide_stderr=not verbose) 278 | if rc != 0: 279 | if verbose: 280 | print("Directory %s not under git control" % root) 281 | raise NotThisMethod("'git rev-parse --git-dir' returned error") 282 | 283 | # if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty] 284 | # if there isn't one, this yields HEX[-dirty] (no NUM) 285 | describe_out, rc = runner(GITS, [ 286 | "describe", "--tags", "--dirty", "--always", "--long", 287 | "--match", f"{tag_prefix}[[:digit:]]*" 288 | ], cwd=root) 289 | # --long was added in git-1.5.5 290 | if describe_out is None: 291 | raise NotThisMethod("'git describe' failed") 292 | describe_out = describe_out.strip() 293 | full_out, rc = runner(GITS, ["rev-parse", "HEAD"], cwd=root) 294 | if full_out is None: 295 | raise NotThisMethod("'git rev-parse' failed") 296 | full_out = full_out.strip() 297 | 298 | pieces: Dict[str, Any] = {} 299 | pieces["long"] = full_out 300 | pieces["short"] = full_out[:7] # maybe improved later 301 | pieces["error"] = None 302 | 303 | branch_name, rc = runner(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], 304 | cwd=root) 305 | # --abbrev-ref was added in git-1.6.3 306 | if rc != 0 or branch_name is None: 307 | raise NotThisMethod("'git rev-parse --abbrev-ref' returned error") 308 | branch_name = branch_name.strip() 309 | 310 | if branch_name == "HEAD": 311 | # If we aren't exactly on a branch, pick a branch which represents 312 | # the current commit. If all else fails, we are on a branchless 313 | # commit. 314 | branches, rc = runner(GITS, ["branch", "--contains"], cwd=root) 315 | # --contains was added in git-1.5.4 316 | if rc != 0 or branches is None: 317 | raise NotThisMethod("'git branch --contains' returned error") 318 | branches = branches.split("\n") 319 | 320 | # Remove the first line if we're running detached 321 | if "(" in branches[0]: 322 | branches.pop(0) 323 | 324 | # Strip off the leading "* " from the list of branches. 325 | branches = [branch[2:] for branch in branches] 326 | if "master" in branches: 327 | branch_name = "master" 328 | elif not branches: 329 | branch_name = None 330 | else: 331 | # Pick the first branch that is returned. Good or bad. 332 | branch_name = branches[0] 333 | 334 | pieces["branch"] = branch_name 335 | 336 | # parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty] 337 | # TAG might have hyphens. 338 | git_describe = describe_out 339 | 340 | # look for -dirty suffix 341 | dirty = git_describe.endswith("-dirty") 342 | pieces["dirty"] = dirty 343 | if dirty: 344 | git_describe = git_describe[:git_describe.rindex("-dirty")] 345 | 346 | # now we have TAG-NUM-gHEX or HEX 347 | 348 | if "-" in git_describe: 349 | # TAG-NUM-gHEX 350 | mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe) 351 | if not mo: 352 | # unparsable. Maybe git-describe is misbehaving? 353 | pieces["error"] = ("unable to parse git-describe output: '%s'" 354 | % describe_out) 355 | return pieces 356 | 357 | # tag 358 | full_tag = mo.group(1) 359 | if not full_tag.startswith(tag_prefix): 360 | if verbose: 361 | fmt = "tag '%s' doesn't start with prefix '%s'" 362 | print(fmt % (full_tag, tag_prefix)) 363 | pieces["error"] = ("tag '%s' doesn't start with prefix '%s'" 364 | % (full_tag, tag_prefix)) 365 | return pieces 366 | pieces["closest-tag"] = full_tag[len(tag_prefix):] 367 | 368 | # distance: number of commits since tag 369 | pieces["distance"] = int(mo.group(2)) 370 | 371 | # commit: short hex revision ID 372 | pieces["short"] = mo.group(3) 373 | 374 | else: 375 | # HEX: no tags 376 | pieces["closest-tag"] = None 377 | out, rc = runner(GITS, ["rev-list", "HEAD", "--left-right"], cwd=root) 378 | pieces["distance"] = len(out.split()) # total number of commits 379 | 380 | # commit date: see ISO-8601 comment in git_versions_from_keywords() 381 | date = runner(GITS, ["show", "-s", "--format=%ci", "HEAD"], cwd=root)[0].strip() 382 | # Use only the last line. Previous lines may contain GPG signature 383 | # information. 384 | date = date.splitlines()[-1] 385 | pieces["date"] = date.strip().replace(" ", "T", 1).replace(" ", "", 1) 386 | 387 | return pieces 388 | 389 | 390 | def plus_or_dot(pieces: Dict[str, Any]) -> str: 391 | """Return a + if we don't already have one, else return a .""" 392 | if "+" in pieces.get("closest-tag", ""): 393 | return "." 394 | return "+" 395 | 396 | 397 | def render_pep440(pieces: Dict[str, Any]) -> str: 398 | """Build up version string, with post-release "local version identifier". 399 | 400 | Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you 401 | get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty 402 | 403 | Exceptions: 404 | 1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty] 405 | """ 406 | if pieces["closest-tag"]: 407 | rendered = pieces["closest-tag"] 408 | if pieces["distance"] or pieces["dirty"]: 409 | rendered += plus_or_dot(pieces) 410 | rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) 411 | if pieces["dirty"]: 412 | rendered += ".dirty" 413 | else: 414 | # exception #1 415 | rendered = "0+untagged.%d.g%s" % (pieces["distance"], 416 | pieces["short"]) 417 | if pieces["dirty"]: 418 | rendered += ".dirty" 419 | return rendered 420 | 421 | 422 | def render_pep440_branch(pieces: Dict[str, Any]) -> str: 423 | """TAG[[.dev0]+DISTANCE.gHEX[.dirty]] . 424 | 425 | The ".dev0" means not master branch. Note that .dev0 sorts backwards 426 | (a feature branch will appear "older" than the master branch). 427 | 428 | Exceptions: 429 | 1: no tags. 0[.dev0]+untagged.DISTANCE.gHEX[.dirty] 430 | """ 431 | if pieces["closest-tag"]: 432 | rendered = pieces["closest-tag"] 433 | if pieces["distance"] or pieces["dirty"]: 434 | if pieces["branch"] != "master": 435 | rendered += ".dev0" 436 | rendered += plus_or_dot(pieces) 437 | rendered += "%d.g%s" % (pieces["distance"], pieces["short"]) 438 | if pieces["dirty"]: 439 | rendered += ".dirty" 440 | else: 441 | # exception #1 442 | rendered = "0" 443 | if pieces["branch"] != "master": 444 | rendered += ".dev0" 445 | rendered += "+untagged.%d.g%s" % (pieces["distance"], 446 | pieces["short"]) 447 | if pieces["dirty"]: 448 | rendered += ".dirty" 449 | return rendered 450 | 451 | 452 | def pep440_split_post(ver: str) -> Tuple[str, Optional[int]]: 453 | """Split pep440 version string at the post-release segment. 454 | 455 | Returns the release segments before the post-release and the 456 | post-release version number (or -1 if no post-release segment is present). 457 | """ 458 | vc = str.split(ver, ".post") 459 | return vc[0], int(vc[1] or 0) if len(vc) == 2 else None 460 | 461 | 462 | def render_pep440_pre(pieces: Dict[str, Any]) -> str: 463 | """TAG[.postN.devDISTANCE] -- No -dirty. 464 | 465 | Exceptions: 466 | 1: no tags. 0.post0.devDISTANCE 467 | """ 468 | if pieces["closest-tag"]: 469 | if pieces["distance"]: 470 | # update the post release segment 471 | tag_version, post_version = pep440_split_post(pieces["closest-tag"]) 472 | rendered = tag_version 473 | if post_version is not None: 474 | rendered += ".post%d.dev%d" % (post_version + 1, pieces["distance"]) 475 | else: 476 | rendered += ".post0.dev%d" % (pieces["distance"]) 477 | else: 478 | # no commits, use the tag as the version 479 | rendered = pieces["closest-tag"] 480 | else: 481 | # exception #1 482 | rendered = "0.post0.dev%d" % pieces["distance"] 483 | return rendered 484 | 485 | 486 | def render_pep440_post(pieces: Dict[str, Any]) -> str: 487 | """TAG[.postDISTANCE[.dev0]+gHEX] . 488 | 489 | The ".dev0" means dirty. Note that .dev0 sorts backwards 490 | (a dirty tree will appear "older" than the corresponding clean one), 491 | but you shouldn't be releasing software with -dirty anyways. 492 | 493 | Exceptions: 494 | 1: no tags. 0.postDISTANCE[.dev0] 495 | """ 496 | if pieces["closest-tag"]: 497 | rendered = pieces["closest-tag"] 498 | if pieces["distance"] or pieces["dirty"]: 499 | rendered += ".post%d" % pieces["distance"] 500 | if pieces["dirty"]: 501 | rendered += ".dev0" 502 | rendered += plus_or_dot(pieces) 503 | rendered += "g%s" % pieces["short"] 504 | else: 505 | # exception #1 506 | rendered = "0.post%d" % pieces["distance"] 507 | if pieces["dirty"]: 508 | rendered += ".dev0" 509 | rendered += "+g%s" % pieces["short"] 510 | return rendered 511 | 512 | 513 | def render_pep440_post_branch(pieces: Dict[str, Any]) -> str: 514 | """TAG[.postDISTANCE[.dev0]+gHEX[.dirty]] . 515 | 516 | The ".dev0" means not master branch. 517 | 518 | Exceptions: 519 | 1: no tags. 0.postDISTANCE[.dev0]+gHEX[.dirty] 520 | """ 521 | if pieces["closest-tag"]: 522 | rendered = pieces["closest-tag"] 523 | if pieces["distance"] or pieces["dirty"]: 524 | rendered += ".post%d" % pieces["distance"] 525 | if pieces["branch"] != "master": 526 | rendered += ".dev0" 527 | rendered += plus_or_dot(pieces) 528 | rendered += "g%s" % pieces["short"] 529 | if pieces["dirty"]: 530 | rendered += ".dirty" 531 | else: 532 | # exception #1 533 | rendered = "0.post%d" % pieces["distance"] 534 | if pieces["branch"] != "master": 535 | rendered += ".dev0" 536 | rendered += "+g%s" % pieces["short"] 537 | if pieces["dirty"]: 538 | rendered += ".dirty" 539 | return rendered 540 | 541 | 542 | def render_pep440_old(pieces: Dict[str, Any]) -> str: 543 | """TAG[.postDISTANCE[.dev0]] . 544 | 545 | The ".dev0" means dirty. 546 | 547 | Exceptions: 548 | 1: no tags. 0.postDISTANCE[.dev0] 549 | """ 550 | if pieces["closest-tag"]: 551 | rendered = pieces["closest-tag"] 552 | if pieces["distance"] or pieces["dirty"]: 553 | rendered += ".post%d" % pieces["distance"] 554 | if pieces["dirty"]: 555 | rendered += ".dev0" 556 | else: 557 | # exception #1 558 | rendered = "0.post%d" % pieces["distance"] 559 | if pieces["dirty"]: 560 | rendered += ".dev0" 561 | return rendered 562 | 563 | 564 | def render_git_describe(pieces: Dict[str, Any]) -> str: 565 | """TAG[-DISTANCE-gHEX][-dirty]. 566 | 567 | Like 'git describe --tags --dirty --always'. 568 | 569 | Exceptions: 570 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 571 | """ 572 | if pieces["closest-tag"]: 573 | rendered = pieces["closest-tag"] 574 | if pieces["distance"]: 575 | rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) 576 | else: 577 | # exception #1 578 | rendered = pieces["short"] 579 | if pieces["dirty"]: 580 | rendered += "-dirty" 581 | return rendered 582 | 583 | 584 | def render_git_describe_long(pieces: Dict[str, Any]) -> str: 585 | """TAG-DISTANCE-gHEX[-dirty]. 586 | 587 | Like 'git describe --tags --dirty --always -long'. 588 | The distance/hash is unconditional. 589 | 590 | Exceptions: 591 | 1: no tags. HEX[-dirty] (note: no 'g' prefix) 592 | """ 593 | if pieces["closest-tag"]: 594 | rendered = pieces["closest-tag"] 595 | rendered += "-%d-g%s" % (pieces["distance"], pieces["short"]) 596 | else: 597 | # exception #1 598 | rendered = pieces["short"] 599 | if pieces["dirty"]: 600 | rendered += "-dirty" 601 | return rendered 602 | 603 | 604 | def render(pieces: Dict[str, Any], style: str) -> Dict[str, Any]: 605 | """Render the given version pieces into the requested style.""" 606 | if pieces["error"]: 607 | return {"version": "unknown", 608 | "full-revisionid": pieces.get("long"), 609 | "dirty": None, 610 | "error": pieces["error"], 611 | "date": None} 612 | 613 | if not style or style == "default": 614 | style = "pep440" # the default 615 | 616 | if style == "pep440": 617 | rendered = render_pep440(pieces) 618 | elif style == "pep440-branch": 619 | rendered = render_pep440_branch(pieces) 620 | elif style == "pep440-pre": 621 | rendered = render_pep440_pre(pieces) 622 | elif style == "pep440-post": 623 | rendered = render_pep440_post(pieces) 624 | elif style == "pep440-post-branch": 625 | rendered = render_pep440_post_branch(pieces) 626 | elif style == "pep440-old": 627 | rendered = render_pep440_old(pieces) 628 | elif style == "git-describe": 629 | rendered = render_git_describe(pieces) 630 | elif style == "git-describe-long": 631 | rendered = render_git_describe_long(pieces) 632 | else: 633 | raise ValueError("unknown style '%s'" % style) 634 | 635 | return {"version": rendered, "full-revisionid": pieces["long"], 636 | "dirty": pieces["dirty"], "error": None, 637 | "date": pieces.get("date")} 638 | 639 | 640 | def get_versions() -> Dict[str, Any]: 641 | """Get version information or return default if unable to do so.""" 642 | # I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have 643 | # __file__, we can work backwards from there to the root. Some 644 | # py2exe/bbfreeze/non-CPython implementations don't do __file__, in which 645 | # case we can only use expanded keywords. 646 | 647 | cfg = get_config() 648 | verbose = cfg.verbose 649 | 650 | try: 651 | return git_versions_from_keywords(get_keywords(), cfg.tag_prefix, 652 | verbose) 653 | except NotThisMethod: 654 | pass 655 | 656 | try: 657 | root = os.path.realpath(__file__) 658 | # versionfile_source is the relative path from the top of the source 659 | # tree (where the .git directory might live) to this file. Invert 660 | # this to find the root from __file__. 661 | for _ in cfg.versionfile_source.split('/'): 662 | root = os.path.dirname(root) 663 | except NameError: 664 | return {"version": "0+unknown", "full-revisionid": None, 665 | "dirty": None, 666 | "error": "unable to find root of source tree", 667 | "date": None} 668 | 669 | try: 670 | pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose) 671 | return render(pieces, cfg.style) 672 | except NotThisMethod: 673 | pass 674 | 675 | try: 676 | if cfg.parentdir_prefix: 677 | return versions_from_parentdir(cfg.parentdir_prefix, root, verbose) 678 | except NotThisMethod: 679 | pass 680 | 681 | return {"version": "0+unknown", "full-revisionid": None, 682 | "dirty": None, 683 | "error": "unable to compute version", "date": None} 684 | -------------------------------------------------------------------------------- /xff/middleware.py: -------------------------------------------------------------------------------- 1 | ''' XFF Middleware ''' 2 | import logging 3 | import re 4 | 5 | from django.conf import settings 6 | from django.http import HttpResponseBadRequest, HttpResponseNotFound 7 | 8 | logger = logging.getLogger(__name__) 9 | 10 | 11 | class XForwardedForMiddleware: 12 | ''' 13 | Fix HTTP_REMOTE_ADDR header to show client IP in a proxied environment. 14 | 15 | WARNING: If you are going to trust the address, you need to know how 16 | many proxies you have in chain. Nothing stops a malicious client from 17 | sending one and your reverse proxies adding one. 18 | 19 | You can set the exact number of reverse proxies by adding the 20 | XFF_TRUSTED_PROXY_DEPTH setting. Without it, the header will remain 21 | insecure even with this middleware. Setting XFF_STRICT = True will 22 | cause a bad request to be sent on spoofed or wrongly routed requests. 23 | XFF_ALWAYS_PROXY will drop all requests with too little depth. 24 | XFF_NO_SPOOFING will drop connections with too many headers. 25 | 26 | This middleware will automatically clean the X-Forwarded-For header 27 | unless XFF_CLEAN = False is set. 28 | 29 | By default, this middleware rewrites HTTP_REMOTE_ADDR. To leave it 30 | untouched, set XFF_REWRITE_REMOTE_ADDR = False. 31 | 32 | XFF_LOOSE_UNSAFE = True will simply shut up and set the last in the 33 | stack. 34 | 35 | XFF_EXEMPT_URLS can be an iterable (eg. list) that defines URLs as 36 | regexps that will not be checked. XFF_EXEMPT_STEALTH = True will 37 | return a 404 when all proxies are present. This is nice for a 38 | healthcheck URL that is not for the public eye. 39 | 40 | XFF_HEADER_REQUIRED = True will return a bad request when the header 41 | is not set. By default it takes the same value as XFF_ALWAYS_PROXY. 42 | ''' 43 | def __init__(self, get_response=None): 44 | self.get_response = get_response 45 | 46 | self.stealth = getattr(settings, 'XFF_EXEMPT_STEALTH', False) 47 | self.loose = getattr(settings, 'XFF_LOOSE_UNSAFE', False) 48 | self.strict = getattr(settings, 'XFF_STRICT', False) 49 | self.always_proxy = getattr(settings, 'XFF_ALWAYS_PROXY', False) 50 | self.no_spoofing = getattr(settings, 'XFF_NO_SPOOFING', False) 51 | self.header_required = getattr(settings, 'XFF_HEADER_REQUIRED', 52 | (self.always_proxy or self.strict)) 53 | self.clean = getattr(settings, 'XFF_CLEAN', True) 54 | self.rewrite_remote = getattr(settings, 'XFF_REWRITE_REMOTE_ADDR', 55 | True) 56 | 57 | self.exempt_urls = [ 58 | re.compile(expr) 59 | for expr in getattr(settings, 'XFF_EXEMPT_URLS', []) 60 | ] 61 | 62 | def get_trusted_depth(self, request): 63 | return getattr(settings, 'XFF_TRUSTED_PROXY_DEPTH', 0) 64 | 65 | def __call__(self, request): 66 | ''' 67 | The beef. 68 | ''' 69 | path = request.path_info.lstrip('/') 70 | depth = self.get_trusted_depth(request) 71 | exempt = any(m.match(path) for m in self.exempt_urls) 72 | 73 | if header := request.headers.get("X-Forwarded-For"): 74 | levels = [x.strip() for x in header.split(',')] 75 | 76 | if len(levels) >= depth and exempt and self.stealth: 77 | return HttpResponseNotFound() 78 | 79 | if self.loose or exempt: 80 | if self.rewrite_remote: 81 | request.META['REMOTE_ADDR'] = levels[0] 82 | return self.get_response(request) 83 | 84 | if len(levels) != depth and self.strict: 85 | logger.warning(( 86 | "Incorrect proxy depth in incoming request.\n" + 87 | 'Expected {} and got {} remote addresses in ' + 88 | 'X-Forwarded-For header.') 89 | .format( 90 | depth, len(levels))) 91 | return HttpResponseBadRequest() 92 | 93 | if len(levels) < depth or depth == 0: 94 | logger.warning( 95 | 'Not running behind as many reverse proxies as expected.' + 96 | "\nThe right value for XFF_TRUSTED_PROXY_DEPTH for this " + 97 | 'request is {} and {} is configured.'.format( 98 | len(levels), depth) 99 | ) 100 | if self.always_proxy: 101 | return HttpResponseBadRequest() 102 | 103 | depth = len(levels) 104 | elif len(levels) > depth: 105 | logger.info( 106 | ('X-Forwarded-For spoof attempt with {} addresses when ' + 107 | '{} expected. Full header: {}').format( 108 | len(levels), depth, header)) 109 | if self.no_spoofing: 110 | return HttpResponseBadRequest() 111 | 112 | if self.rewrite_remote: 113 | request.META['REMOTE_ADDR'] = levels[-depth] 114 | 115 | if self.clean: 116 | cleaned = ','.join(levels[-depth:]) 117 | request.META['HTTP_X_FORWARDED_FOR'] = cleaned 118 | request.__dict__.pop("headers", None) # Clear headers cache 119 | 120 | elif self.header_required and not (exempt or self.loose): 121 | logger.error( 122 | 'No X-Forwarded-For header set, not behind a reverse proxy.') 123 | return HttpResponseBadRequest() 124 | 125 | return self.get_response(request) 126 | --------------------------------------------------------------------------------