boilerplates 1.2.0.dev2__tar.gz → 1.2.0.dev3__tar.gz

{boilerplates-1.2.0.dev2/boilerplates.egg-info → boilerplates-1.2.0.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boilerplates
-Version: 1.2.0.dev2
+Version: 1.2.0.dev3
 Summary: Various boilerplates used in almost all of my Python packages.
 Home-page: https://github.com/mbdevpl/python-boilerplates
 Download-URL: 
@@ -8,7 +8,7 @@ Author: Mateusz Bysiek, Stian Hanssen
 Author-email: mateusz.bysiek@gmail.com
 Maintainer: Mateusz Bysiek
 Maintainer-email: mateusz.bysiek@gmail.com
-License-Expression: Apache-2.0
+License: Apache License 2.0
 Keywords: git,logging,packaging,releasing
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -33,17 +33,14 @@ Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE
 License-File: NOTICE
 Provides-Extra: setup
-Requires-Dist: build~=1.2; extra == "setup"
 Requires-Dist: docutils~=0.20; extra == "setup"
 Requires-Dist: Pygments~=2.14; extra == "setup"
 Requires-Dist: setuptools>=77.0.3; extra == "setup"
-Requires-Dist: version-query~=1.6; extra == "setup"
 Provides-Extra: packaging-tests
-Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: docutils~=0.20; extra == "packaging-tests"
 Requires-Dist: Pygments~=2.14; extra == "packaging-tests"
 Requires-Dist: setuptools>=77.0.3; extra == "packaging-tests"
-Requires-Dist: version-query~=1.6; extra == "packaging-tests"
+Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: pip>=24.0; extra == "packaging-tests"
 Requires-Dist: wheel>=0.43; extra == "packaging-tests"
 Provides-Extra: config
@@ -62,8 +59,8 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license
 Dynamic: license-file
-Dynamic: license-expression
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: provides-extra
@@ -99,7 +96,7 @@ Various boilerplates used in almost all of my Python packages.
     :alt: grade from Codacy
 
 .. image:: https://img.shields.io/github/license/mbdevpl/python-boilerplates.svg
-    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/NOTICE
+    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/NOTICE
     :alt: license
 
 This package includes boilerplates for various common tasks in Python packages, such as building
@@ -114,9 +111,9 @@ Requirements
 
 Python version 3.9 or later.
 
-Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/requirements.txt>`_.
+Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/requirements.txt>`_.
 
-Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/requirements_test.txt>`_.
+Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/requirements_test.txt>`_.
 
 Tested on Linux, macOS and Windows.
 
@@ -399,7 +396,7 @@ Your example ``cli.py`` file which defines your command-line interface may look
         verbosity = boilerplates.cli.get_verbosity_level(parsed_args)
         ...
 
-You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/examples.ipynb>`_ notebook.
+You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/examples.ipynb>`_ notebook.
 Please see the ``boilerplates.cli`` module for details of the available features.
 
 And then, an example ``__main__.py`` file may look like:

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/boilerplates/packaging_tests.py

@@ -1,6 +1,8 @@
 """Test definitions for package building."""
 
+import contextlib
 import importlib
+import io
 import logging
 import os
 import pathlib
@@ -100,43 +102,49 @@ class PackagingTests(unittest.TestCase):
         expanded_args = expand_args_by_globbing_items('*.py', cwd=pathlib.Path(self.pkg_name))
         self.assertIn('__init__.py', expanded_args)
 
+    def test_setup_help(self):
+        stdout_buffer = io.StringIO()
+        with contextlib.redirect_stdout(stdout_buffer):
+            run_module('setup', '--help')
+        self.assertIn('usage: setup.py', stdout_buffer.getvalue())
+
     def test_build(self):
         run_program(sys.executable, '-m', 'build')
         self.assertTrue(os.path.isdir('dist'))
 
-    def test_build_binary(self):
-        run_module('setup', 'bdist')
+    def test_build_wheel(self):
+        run_module('build', '--wheel')
         self.assertTrue(os.path.isdir('dist'))
 
-    def test_build_wheel(self):
-        run_module('setup', 'bdist_wheel')
+    def test_build_wheel_no_isolation(self):
+        run_module('build', '--wheel', '--no-isolation')
         self.assertTrue(os.path.isdir('dist'))
 
     def test_build_source(self):
-        run_module('setup', 'sdist', '--formats=gztar,zip')
+        run_module('build', '--sdist')
+        self.assertTrue(os.path.isdir('dist'))
+
+    def test_build_source_no_isolation(self):
+        run_module('build', '--sdist', '--no-isolation')
         self.assertTrue(os.path.isdir('dist'))
 
     def test_install_code(self):
         with tempfile.TemporaryDirectory() as temporary_folder:
-            run_pip('install', '--prefix', temporary_folder, '.')
+            run_pip('install', '--ignore-installed', '--prefix', temporary_folder, '.')
         self.assertFalse(pathlib.Path(temporary_folder).exists())
 
     def test_install_source_tar(self):
         with tempfile.TemporaryDirectory() as temporary_folder:
             run_pip(
-                'install', '--prefix', temporary_folder, f'dist/*-{self.version}.tar.gz', glob=True)
-        self.assertFalse(pathlib.Path(temporary_folder).exists())
-
-    def test_install_source_zip(self):
-        with tempfile.TemporaryDirectory() as temporary_folder:
-            run_pip(
-                'install', '--prefix', temporary_folder, f'dist/*-{self.version}.zip', glob=True)
+                'install', '--ignore-installed', '--prefix', temporary_folder,
+                f'dist/*-{self.version}.tar.gz', glob=True)
         self.assertFalse(pathlib.Path(temporary_folder).exists())
 
     def test_install_wheel(self):
         with tempfile.TemporaryDirectory() as temporary_folder:
             run_pip(
-                'install', '--prefix', temporary_folder, f'dist/*-{self.version}-*.whl', glob=True)
+                'install', '--ignore-installed', '--prefix', temporary_folder,
+                f'dist/*-{self.version}-*.whl', glob=True)
         self.assertFalse(pathlib.Path(temporary_folder).exists())
 
     def test_pip_error(self):

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/boilerplates/sentry.py

@@ -20,11 +20,11 @@ _LOG = logging.getLogger(__name__)
 class Sentry:
     """Sentry configuration.
 
-    For parameters 'dsn', 'release' and 'environment', the value is taken
-    from the environment variable if it is set, otherwise from the class
-    attribute if it is set.
-
-    For each parameter, the name of the environment variable name is 'SENTRY_'
+    For parameters 'dsn', 'release', 'environment', 'default_integrations', 'debug',
+    'attach_stacktrace', 'shutdown_timeout', 'traces_sample_rate' and 'profiles_sample_rate'
+    the value is taken from the environment variable if it is set,
+    otherwise from the class attribute if it is set.
+    For those parameters, the expected name of the environment variable name is 'SENTRY_'
     followed by the parameter name in upper case.
 
     The class attribute tags, if set, will be added to the global scope of the
@@ -56,7 +56,7 @@ class Sentry:
     """
 
     default_integrations: bool = True
-    """If true, enable Sentry's default integrations besides the ones set via 'integrations'."""
+    """If True, enable Sentry's default integrations besides the ones set via 'integrations'."""
 
     debug: bool = False
     """If True, enable debug mode for the Sentry SDK."""
@@ -91,6 +91,21 @@ class Sentry:
         assert param_name in ('dsn', 'release', 'environment'), param_name
         return os.environ.get(f'SENTRY_{param_name.upper()}', getattr(cls, param_name, None))
 
+    @classmethod
+    def _get_float_param(cls, param_name: str) -> float:
+        assert param_name in (
+            'shutdown_timeout', 'traces_sample_rate', 'profiles_sample_rate'), param_name
+        if f'SENTRY_{param_name.upper()}' in os.environ:
+            return float(os.environ[f'SENTRY_{param_name.upper()}'])
+        return getattr(cls, param_name)
+
+    @classmethod
+    def _get_bool_param(cls, param_name: str) -> bool:
+        assert param_name in ('default_integrations', 'debug', 'attach_stacktrace'), param_name
+        if f'SENTRY_{param_name.upper()}' in os.environ:
+            return os.environ[f'SENTRY_{param_name.upper()}'].lower() in {'true', 'yes', 'on', '1'}
+        return getattr(cls, param_name)
+
     @classmethod
     def is_dsn_set(cls) -> bool:
         """Check if Sentry DSN parameter is set, thus if Sentry SDK should be initialised or not."""
@@ -108,14 +123,14 @@ class Sentry:
             release=cls._get_str_param('release'),
             environment=cls._get_str_param('environment'),
             integrations=cls.integrations,
-            traces_sample_rate=cls.traces_sample_rate,
-            profiles_sample_rate=cls.profiles_sample_rate,
-            enable_tracing=cls.profiles_sample_rate > 0,
-            debug=cls.debug,
-            attach_stacktrace=cls.attach_stacktrace,
-            shutdown_timeout=cls.shutdown_timeout,
+            traces_sample_rate=cls._get_float_param('traces_sample_rate'),
+            profiles_sample_rate=cls._get_float_param('profiles_sample_rate'),
+            enable_tracing=cls._get_float_param('profiles_sample_rate') > 0,
+            debug=cls._get_bool_param('debug'),
+            attach_stacktrace=cls._get_bool_param('attach_stacktrace'),
+            shutdown_timeout=cls._get_float_param('shutdown_timeout'),
             send_default_pii=cls.send_default_pii,
-            default_integrations=cls.default_integrations,
+            default_integrations=cls._get_bool_param('default_integrations'),
             **kwargs)
 
         sentry_sdk.set_tags(cls.tags)

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3/boilerplates.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boilerplates
-Version: 1.2.0.dev2
+Version: 1.2.0.dev3
 Summary: Various boilerplates used in almost all of my Python packages.
 Home-page: https://github.com/mbdevpl/python-boilerplates
 Download-URL: 
@@ -8,7 +8,7 @@ Author: Mateusz Bysiek, Stian Hanssen
 Author-email: mateusz.bysiek@gmail.com
 Maintainer: Mateusz Bysiek
 Maintainer-email: mateusz.bysiek@gmail.com
-License-Expression: Apache-2.0
+License: Apache License 2.0
 Keywords: git,logging,packaging,releasing
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -33,17 +33,14 @@ Description-Content-Type: text/x-rst; charset=UTF-8
 License-File: LICENSE
 License-File: NOTICE
 Provides-Extra: setup
-Requires-Dist: build~=1.2; extra == "setup"
 Requires-Dist: docutils~=0.20; extra == "setup"
 Requires-Dist: Pygments~=2.14; extra == "setup"
 Requires-Dist: setuptools>=77.0.3; extra == "setup"
-Requires-Dist: version-query~=1.6; extra == "setup"
 Provides-Extra: packaging-tests
-Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: docutils~=0.20; extra == "packaging-tests"
 Requires-Dist: Pygments~=2.14; extra == "packaging-tests"
 Requires-Dist: setuptools>=77.0.3; extra == "packaging-tests"
-Requires-Dist: version-query~=1.6; extra == "packaging-tests"
+Requires-Dist: build~=1.2; extra == "packaging-tests"
 Requires-Dist: pip>=24.0; extra == "packaging-tests"
 Requires-Dist: wheel>=0.43; extra == "packaging-tests"
 Provides-Extra: config
@@ -62,8 +59,8 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license
 Dynamic: license-file
-Dynamic: license-expression
 Dynamic: maintainer
 Dynamic: maintainer-email
 Dynamic: provides-extra
@@ -99,7 +96,7 @@ Various boilerplates used in almost all of my Python packages.
     :alt: grade from Codacy
 
 .. image:: https://img.shields.io/github/license/mbdevpl/python-boilerplates.svg
-    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/NOTICE
+    :target: https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/NOTICE
     :alt: license
 
 This package includes boilerplates for various common tasks in Python packages, such as building
@@ -114,9 +111,9 @@ Requirements
 
 Python version 3.9 or later.
 
-Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/requirements.txt>`_.
+Python libraries as specified in `requirements.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/requirements.txt>`_.
 
-Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/requirements_test.txt>`_.
+Building and running tests additionally requires packages listed in `requirements_test.txt <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/requirements_test.txt>`_.
 
 Tested on Linux, macOS and Windows.
 
@@ -399,7 +396,7 @@ Your example ``cli.py`` file which defines your command-line interface may look
         verbosity = boilerplates.cli.get_verbosity_level(parsed_args)
         ...
 
-You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev2/examples.ipynb>`_ notebook.
+You can see the above example in action in the `examples.ipynb <https://github.com/mbdevpl/python-boilerplates/blob/v1.2.0.dev3/examples.ipynb>`_ notebook.
 Please see the ``boilerplates.cli`` module for details of the available features.
 
 And then, an example ``__main__.py`` file may look like:

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/boilerplates.egg-info/requires.txt

@@ -11,11 +11,10 @@ GitPython~=3.1
 colorlog~=6.7
 
 [packaging-tests]
-build~=1.2
 docutils~=0.20
 Pygments~=2.14
 setuptools>=77.0.3
-version-query~=1.6
+build~=1.2
 pip>=24.0
 wheel>=0.43
 
@@ -23,8 +22,6 @@ wheel>=0.43
 sentry-sdk[pure_eval]~=2.5
 
 [setup]
-build~=1.2
 docutils~=0.20
 Pygments~=2.14
 setuptools>=77.0.3
-version-query~=1.6

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/pyproject.toml

@@ -1,12 +1,13 @@
 [build-system]
+build-backend = 'setuptools.build_meta'
 requires = [
-    'build >= 0.10',
+    'boilerplates[setup] ~= 1.1, >= 1.1.4',
     'docutils ~= 0.20',
     'GitPython ~= 3.1',
     'packaging >= 24.0',
     'Pygments ~= 2.14',
     'semver >= 2.13, < 3.1',
-    'setuptools >= 67.4'
+    'setuptools >= 70.0.3'
 ]
 
 [tool.flake8]

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/requirements_packaging_tests.txt

@@ -1,3 +1,4 @@
 -r requirements_setup.txt
+build ~= 1.2
 pip >= 24.0
 wheel >= 0.43

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/requirements_setup.txt

@@ -1,5 +1,3 @@
-build ~= 1.2
 docutils ~= 0.20
 Pygments ~= 2.14
 setuptools >= 77.0.3
-version-query ~= 1.6

{boilerplates-1.2.0.dev2 → boilerplates-1.2.0.dev3}/requirements_test.txt

@@ -6,4 +6,3 @@
 -r requirements_sentry.txt
 -r requirements_cli.txt
 -r requirements_git_repo_tests.txt
-version-query ~= 1.6

boilerplates-1.2.0.dev3/test/test_sentry.py

@@ -0,0 +1,62 @@
+"""Unit tests for Sentry boilerplate."""
+
+import logging
+import sys
+import unittest
+import unittest.mock
+
+import boilerplates.sentry
+
+
+class SentryTests(unittest.TestCase):
+
+    def test_init(self):
+        with self.assertLogs('boilerplates.sentry', logging.INFO) as context:
+            boilerplates.sentry.Sentry.init()
+        self.assertEqual(len(context.output), 1, msg=context.output)
+        self.assertIn('skipping Sentry SDK initialisation', context.output[0])
+
+    def test_init_without_dsn(self):
+        class Sentry(boilerplates.sentry.Sentry):
+            dsn = ''
+        with self.assertLogs('boilerplates.sentry', logging.INFO) as context, \
+                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
+            Sentry.init()
+        sentry_sdk_init_mock.assert_not_called()
+        self.assertEqual(len(context.output), 1, msg=context.output)
+        self.assertIn('skipping Sentry SDK initialisation', context.output[0])
+
+    @unittest.skipUnless(sys.version_info >= (3, 10), 'this test requires Python 3.10')
+    def test_init_with_dsn(self):
+        class Sentry(boilerplates.sentry.Sentry):
+            dsn = 'https://spam@ham.ingest.sentry.io/eggs'
+        with self.assertNoLogs('boilerplates.sentry', logging.INFO), \
+                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
+            Sentry.init()
+        sentry_sdk_init_mock.assert_called_once()
+
+    @unittest.skipUnless(sys.version_info >= (3, 10), 'this test requires Python 3.10')
+    def test_init_with_envvar(self):
+        class Sentry(boilerplates.sentry.Sentry):
+            pass
+        environ_override = {'SENTRY_DSN': 'https://spam@ham.ingest.sentry.io/eggs'}
+        with unittest.mock.patch.dict('os.environ', environ_override), \
+                self.assertNoLogs('boilerplates.sentry', logging.INFO), \
+                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
+            Sentry.init()
+        sentry_sdk_init_mock.assert_called_once()
+
+    @unittest.skipUnless(sys.version_info >= (3, 10), 'this test requires Python 3.10')
+    def test_configure_with_envvars(self):
+        class Sentry(boilerplates.sentry.Sentry):
+            dsn = 'https://spam@ham.ingest.sentry.io/eggs'
+        environ_override = {'SENTRY_PROFILES_SAMPLE_RATE': '0.42', 'SENTRY_DEBUG': 'True'}
+        with unittest.mock.patch.dict('os.environ', environ_override), \
+                self.assertNoLogs('boilerplates.sentry', logging.INFO), \
+                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
+            Sentry.init()
+        sentry_sdk_init_mock.assert_called_once()
+        self.assertIn('profiles_sample_rate', sentry_sdk_init_mock.call_args.kwargs)
+        self.assertEqual(sentry_sdk_init_mock.call_args.kwargs['profiles_sample_rate'], 0.42)
+        self.assertIn('debug', sentry_sdk_init_mock.call_args.kwargs)
+        self.assertTrue(sentry_sdk_init_mock.call_args.kwargs['debug'], 0.42)

boilerplates-1.2.0.dev2/test/test_sentry.py

@@ -1,36 +0,0 @@
-"""Unit tests for Sentry boilerplate."""
-
-import logging
-import sys
-import unittest
-import unittest.mock
-
-import boilerplates.sentry
-
-
-class SentryTests(unittest.TestCase):
-
-    def test_init(self):
-        with self.assertLogs('boilerplates.sentry', logging.INFO) as context:
-            boilerplates.sentry.Sentry.init()
-        self.assertEqual(len(context.output), 1, msg=context.output)
-        self.assertIn('skipping Sentry SDK initialisation', context.output[0])
-
-    def test_init_without_dsn(self):
-        class Sentry(boilerplates.sentry.Sentry):
-            dsn = ''
-        with self.assertLogs('boilerplates.sentry', logging.INFO) as context, \
-                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
-            Sentry.init()
-        sentry_sdk_init_mock.assert_not_called()
-        self.assertEqual(len(context.output), 1, msg=context.output)
-        self.assertIn('skipping Sentry SDK initialisation', context.output[0])
-
-    @unittest.skipUnless(sys.version_info >= (3, 10), 'this test requires Python 3.10')
-    def test_init_with_dsn(self):
-        class Sentry(boilerplates.sentry.Sentry):
-            dsn = 'https://spam@ham.ingest.sentry.io/eggs'
-        with self.assertNoLogs('boilerplates.sentry', logging.INFO), \
-                unittest.mock.patch('sentry_sdk.init') as sentry_sdk_init_mock:
-            Sentry.init()
-        sentry_sdk_init_mock.assert_called_once()