view contrib/python-zstandard/setup.py @ 39696:9de1a1c83cd7

localrepo: document and test bug around opening shared repos

As part of refactoring this code, I realized that we don't
validate the requirements of a shared repository. This commit
documents that next to the requirements validation code and adds a
test demonstrating the buggy behavior.

I'm not sure if I'll fix this. But it is definitely a bug that
users could encounter, as LFS, narrow, and potentially other
extensions dynamically add requirements on first use. One part
of this I'm not sure about is how to handle loading the .hg/hgrc
of the shared repo. We need to do that in order to load extensions.
But we don't want that repo's hgrc to overwrite the current repo's.

Differential Revision: https://phab.mercurial-scm.org/D4572

#!/usr/bin/env python
# Copyright (c) 2016-present, Gregory Szorc
# All rights reserved.
#
# This software may be modified and distributed under the terms
# of the BSD license. See the LICENSE file for details.

import os
import sys
from setuptools import setup

try:
    import cffi
except ImportError:
    cffi = None

import setup_zstd

SUPPORT_LEGACY = False
SYSTEM_ZSTD = False
WARNINGS_AS_ERRORS = False

if os.environ.get('ZSTD_WARNINGS_AS_ERRORS', ''):
    WARNINGS_AS_ERRORS = True

if '--legacy' in sys.argv:
    SUPPORT_LEGACY = True
    sys.argv.remove('--legacy')

if '--system-zstd' in sys.argv:
    SYSTEM_ZSTD = True
    sys.argv.remove('--system-zstd')

if '--warnings-as-errors' in sys.argv:
    WARNINGS_AS_ERRORS = True
    sys.argv.remove('--warning-as-errors')

# Code for obtaining the Extension instance is in its own module to
# facilitate reuse in other projects.
extensions = [
    setup_zstd.get_c_extension(name='zstd',
                               support_legacy=SUPPORT_LEGACY,
                               system_zstd=SYSTEM_ZSTD,
                               warnings_as_errors=WARNINGS_AS_ERRORS),
]

install_requires = []

if cffi:
    import make_cffi
    extensions.append(make_cffi.ffi.distutils_extension())

    # Need change in 1.10 for ffi.from_buffer() to handle all buffer types
    # (like memoryview).
    # Need feature in 1.11 for ffi.gc() to declare size of objects so we avoid
    # garbage collection pitfalls.
    install_requires.append('cffi>=1.11')

version = None

with open('c-ext/python-zstandard.h', 'r') as fh:
    for line in fh:
        if not line.startswith('#define PYTHON_ZSTANDARD_VERSION'):
            continue

        version = line.split()[2][1:-1]
        break

if not version:
    raise Exception('could not resolve package version; '
                    'this should never happen')

setup(
    name='zstandard',
    version=version,
    description='Zstandard bindings for Python',
    long_description=open('README.rst', 'r').read(),
    url='https://github.com/indygreg/python-zstandard',
    author='Gregory Szorc',
    author_email='[e-mail]',
    license='BSD',
    classifiers=[
        'Development Status :: 4 - Beta',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License',
        'Programming Language :: C',
        'Programming Language :: Python :: 2.7',
        'Programming Language :: Python :: 3.4',
        'Programming Language :: Python :: 3.5',
        'Programming Language :: Python :: 3.6',
    ],
    keywords='zstandard zstd compression',
    packages=['zstandard'],
    ext_modules=extensions,
    test_suite='tests',
    install_requires=install_requires,
)