flagsmith-common 2.2.7__tar.gz → 3.1.0__tar.gz

{flagsmith_common-2.2.7 → flagsmith_common-3.1.0}/PKG-INFO

@@ -1,44 +1,45 @@
 Metadata-Version: 2.4
 Name: flagsmith-common
-Version: 2.2.7
+Version: 3.1.0
 Summary: Flagsmith's common library
+Author: Matthew Elwell, Gagan Trivedi, Kim Gustyr, Zach Aysan, Francesco Lo Franco, Rodrigo López Dato, Evandro Myller, Wadii Zaim
 License-Expression: BSD-3-Clause
 License-File: LICENSE
-Author: Matthew Elwell
-Maintainer: Flagsmith Team
-Maintainer-email: support@flagsmith.com
-Requires-Python: >=3.11,<4.0
 Classifier: Framework :: Django
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Provides-Extra: test-tools
-Requires-Dist: backoff (>=2.2.1,<3.0.0)
-Requires-Dist: django (>4,<5)
-Requires-Dist: django-health-check
-Requires-Dist: djangorestframework
-Requires-Dist: djangorestframework-recursive
-Requires-Dist: drf-writable-nested
-Requires-Dist: drf-yasg (>=1.21.10,<2.0.0)
-Requires-Dist: environs (<15)
-Requires-Dist: flagsmith-flag-engine
-Requires-Dist: gunicorn (>=19.1)
-Requires-Dist: prometheus-client (>=0.0.16)
-Requires-Dist: psycopg2-binary (>=2.9,<3)
-Requires-Dist: pyfakefs (>=5,<6) ; extra == "test-tools"
-Requires-Dist: pytest-django (>=4,<5) ; extra == "test-tools"
-Requires-Dist: requests
-Requires-Dist: simplejson (>=3,<4)
+Requires-Dist: django>4,<6 ; extra == 'common-core'
+Requires-Dist: django-health-check ; extra == 'common-core'
+Requires-Dist: djangorestframework-recursive ; extra == 'common-core'
+Requires-Dist: djangorestframework ; extra == 'common-core'
+Requires-Dist: drf-writable-nested ; extra == 'common-core'
+Requires-Dist: drf-yasg>=1.21.10,<2.0.0 ; extra == 'common-core'
+Requires-Dist: environs<15 ; extra == 'common-core'
+Requires-Dist: gunicorn>=19.1 ; extra == 'common-core'
+Requires-Dist: prometheus-client>=0.0.16 ; extra == 'common-core'
+Requires-Dist: psycopg2-binary>=2.9,<3 ; extra == 'common-core'
+Requires-Dist: requests ; extra == 'common-core'
+Requires-Dist: simplejson>=3,<4 ; extra == 'common-core'
+Requires-Dist: typing-extensions ; extra == 'flagsmith-schemas'
+Requires-Dist: backoff>=2.2.1,<3.0.0 ; extra == 'task-processor'
+Requires-Dist: django>4,<6 ; extra == 'task-processor'
+Requires-Dist: django-health-check ; extra == 'task-processor'
+Requires-Dist: prometheus-client>=0.0.16 ; extra == 'task-processor'
+Requires-Dist: pyfakefs>=5,<6 ; extra == 'test-tools'
+Requires-Dist: pytest-django>=4,<5 ; extra == 'test-tools'
+Maintainer: Flagsmith Team
+Maintainer-email: Flagsmith Team <support@flagsmith.com>
+Requires-Python: >=3.11, <4.0
 Project-URL: Changelog, https://github.com/flagsmith/flagsmith-common/blob/main/CHANGELOG.md
 Project-URL: Download, https://github.com/flagsmith/flagsmith-common/releases
 Project-URL: Homepage, https://flagsmith.com
 Project-URL: Issues, https://github.com/flagsmith/flagsmith-common/issues
 Project-URL: Repository, https://github.com/flagsmith/flagsmith-common
+Provides-Extra: common-core
+Provides-Extra: flagsmith-schemas
+Provides-Extra: task-processor
+Provides-Extra: test-tools
 Description-Content-Type: text/markdown
 
 # flagsmith-common
@@ -47,54 +48,28 @@ Description-Content-Type: text/markdown
 
 Flagsmith's common library
 
-### Development Setup
+## Local development
 
-This project uses [Poetry](https://python-poetry.org/) for dependency management and includes a Makefile to simplify common development tasks.
+The project assumes the following tools installed:
 
-#### Prerequisites
+- [uv](https://github.com/astral-sh/uv)
+- [GNU Make](https://www.gnu.org/software/make/)
 
-- Python >= 3.11
-- Make
+To list available Makefile targets, run `make help`.
 
-#### Installation
+To set up local development environment, run `make install`.
 
-You can set up your development environment using the provided Makefile:
+To run linters, run `make lint`.
 
-```bash
-# Install everything (pip, poetry, and project dependencies)
-make install
+To run tests, run `make test`.
 
-# Individual installation steps are also available
-make install-pip       # Upgrade pip
-make install-poetry    # Install Poetry
-make install-packages  # Install project dependencies
-```
-
-#### Development
+## Usage
 
-Run linting checks using pre-commit:
-
-```bash
-make lint
-```
+### Installation
 
-Additional options can be passed to the `install-packages` target:
+1. Install all runtime packages: `uv add flagsmith-common[common-core,task-processor]`
 
-```bash
-# Install with development dependencies
-make install-packages opts="--with dev"
-
-# Install with specific extras
-make install-packages opts="--extras 'feature1 feature2'"
-```
-
-### Usage
-
-#### Installation
-
-1. `poetry add flagsmith-common`
-
-2. `poetry add --G dev flagsmith-common[test-tools]` — this will enable the Pytest fixtures. Skipping this step will make Pytest collection fail due to missing dependencies.
+2. To enable the Pytest fixtures, run `uv add --G dev flagsmith-common[test-tools]`. Skipping this step will make Pytest collection fail due to missing dependencies.
 
 3. Make sure `"common.core"` is in the `INSTALLED_APPS` of your settings module.
 This enables the `manage.py flagsmith` commands.
@@ -104,11 +79,11 @@ This enables the `route` label for Prometheus HTTP metrics.
 
 5. To enable the `/metrics` endpoint, set the `PROMETHEUS_ENABLED` setting to `True`.
 
-#### Test tools
+### Test tools
 
-##### Fixtures
+#### Fixtures
 
-###### `assert_metric`
+##### `assert_metric`
 
 To test your metrics using the `assert_metric` fixture:
 
@@ -127,44 +102,44 @@ def test_my_code__expected_metrics(assert_metric: AssertMetricFixture) -> None:
     )
 ```
 
-###### `saas_mode`
+##### `saas_mode`
 
 The `saas_mode` fixture makes all `common.core.utils.is_saas` calls return `True`.
 
-###### `enterprise_mode`
+##### `enterprise_mode`
 
 The `enterprise_mode` fixture makes all `common.core.utils.is_enterprise` calls return `True`.
 
-##### Markers
+#### Markers
 
-###### `pytest.mark.saas_mode`
+##### `pytest.mark.saas_mode`
 
 Use this mark to auto-use the `saas_mode` fixture.
 
-###### `pytest.mark.enterprise_mode`
+##### `pytest.mark.enterprise_mode`
 
 Use this mark to auto-use the `enterprise_mode` fixture.
 
-#### Metrics
+### Metrics
 
 Flagsmith uses Prometheus to track performance metrics.
 
 The following default metrics are exposed:
 
-##### Common metrics
+#### Common metrics
 
 - `flagsmith_build_info`: Has the labels `version` and `ci_commit_sha`.
 - `flagsmith_http_server_request_duration_seconds`: Histogram labeled with `method`, `route`, and `response_status`.
 - `flagsmith_http_server_requests_total`: Counter labeled with `method`, `route`, and `response_status`.
-- `flagsmith_http_server_response_size_bytes`:Histogram labeled with `method`, `route`, and `response_status`.
+- `flagsmith_http_server_response_size_bytes`: Histogram labeled with `method`, `route`, and `response_status`.
 - `flagsmith_task_processor_enqueued_tasks_total`: Counter labeled with `task_identifier`.
 
-##### Task Processor metrics
+#### Task Processor metrics
 
 - `flagsmith_task_processor_finished_tasks_total`: Counter labeled with `task_identifier`, `task_type` (`"recurring"`, `"standard"`) and `result` (`"success"`, `"failure"`).
 - `flagsmith_task_processor_task_duration_seconds`: Histogram labeled with `task_identifier`, `task_type` (`"recurring"`, `"standard"`) and `result` (`"success"`, `"failure"`).
 
-##### Guidelines
+#### Guidelines
 
 Try to come up with meaningful metrics to cover your feature with when developing it. Refer to [Prometheus best practices][1] when naming your metric and labels.
 
@@ -193,4 +168,3 @@ For testing your metrics, refer to [`assert_metric` documentation][5].
 [3]: https://docs.gunicorn.org/en/stable/design.html#server-model
 [4]: https://prometheus.github.io/client_python/multiprocess
 [5]: #assert_metric
-

{flagsmith_common-2.2.7 → flagsmith_common-3.1.0}/README.md

@@ -4,54 +4,28 @@
 
 Flagsmith's common library
 
-### Development Setup
+## Local development
 
-This project uses [Poetry](https://python-poetry.org/) for dependency management and includes a Makefile to simplify common development tasks.
+The project assumes the following tools installed:
 
-#### Prerequisites
+- [uv](https://github.com/astral-sh/uv)
+- [GNU Make](https://www.gnu.org/software/make/)
 
-- Python >= 3.11
-- Make
+To list available Makefile targets, run `make help`.
 
-#### Installation
+To set up local development environment, run `make install`.
 
-You can set up your development environment using the provided Makefile:
+To run linters, run `make lint`.
 
-```bash
-# Install everything (pip, poetry, and project dependencies)
-make install
+To run tests, run `make test`.
 
-# Individual installation steps are also available
-make install-pip       # Upgrade pip
-make install-poetry    # Install Poetry
-make install-packages  # Install project dependencies
-```
-
-#### Development
-
-Run linting checks using pre-commit:
-
-```bash
-make lint
-```
-
-Additional options can be passed to the `install-packages` target:
-
-```bash
-# Install with development dependencies
-make install-packages opts="--with dev"
-
-# Install with specific extras
-make install-packages opts="--extras 'feature1 feature2'"
-```
-
-### Usage
+## Usage
 
-#### Installation
+### Installation
 
-1. `poetry add flagsmith-common`
+1. Install all runtime packages: `uv add flagsmith-common[common-core,task-processor]`
 
-2. `poetry add --G dev flagsmith-common[test-tools]` — this will enable the Pytest fixtures. Skipping this step will make Pytest collection fail due to missing dependencies.
+2. To enable the Pytest fixtures, run `uv add --G dev flagsmith-common[test-tools]`. Skipping this step will make Pytest collection fail due to missing dependencies.
 
 3. Make sure `"common.core"` is in the `INSTALLED_APPS` of your settings module.
 This enables the `manage.py flagsmith` commands.
@@ -61,11 +35,11 @@ This enables the `route` label for Prometheus HTTP metrics.
 
 5. To enable the `/metrics` endpoint, set the `PROMETHEUS_ENABLED` setting to `True`.
 
-#### Test tools
+### Test tools
 
-##### Fixtures
+#### Fixtures
 
-###### `assert_metric`
+##### `assert_metric`
 
 To test your metrics using the `assert_metric` fixture:
 
@@ -84,44 +58,44 @@ def test_my_code__expected_metrics(assert_metric: AssertMetricFixture) -> None:
     )
 ```
 
-###### `saas_mode`
+##### `saas_mode`
 
 The `saas_mode` fixture makes all `common.core.utils.is_saas` calls return `True`.
 
-###### `enterprise_mode`
+##### `enterprise_mode`
 
 The `enterprise_mode` fixture makes all `common.core.utils.is_enterprise` calls return `True`.
 
-##### Markers
+#### Markers
 
-###### `pytest.mark.saas_mode`
+##### `pytest.mark.saas_mode`
 
 Use this mark to auto-use the `saas_mode` fixture.
 
-###### `pytest.mark.enterprise_mode`
+##### `pytest.mark.enterprise_mode`
 
 Use this mark to auto-use the `enterprise_mode` fixture.
 
-#### Metrics
+### Metrics
 
 Flagsmith uses Prometheus to track performance metrics.
 
 The following default metrics are exposed:
 
-##### Common metrics
+#### Common metrics
 
 - `flagsmith_build_info`: Has the labels `version` and `ci_commit_sha`.
 - `flagsmith_http_server_request_duration_seconds`: Histogram labeled with `method`, `route`, and `response_status`.
 - `flagsmith_http_server_requests_total`: Counter labeled with `method`, `route`, and `response_status`.
-- `flagsmith_http_server_response_size_bytes`:Histogram labeled with `method`, `route`, and `response_status`.
+- `flagsmith_http_server_response_size_bytes`: Histogram labeled with `method`, `route`, and `response_status`.
 - `flagsmith_task_processor_enqueued_tasks_total`: Counter labeled with `task_identifier`.
 
-##### Task Processor metrics
+#### Task Processor metrics
 
 - `flagsmith_task_processor_finished_tasks_total`: Counter labeled with `task_identifier`, `task_type` (`"recurring"`, `"standard"`) and `result` (`"success"`, `"failure"`).
 - `flagsmith_task_processor_task_duration_seconds`: Histogram labeled with `task_identifier`, `task_type` (`"recurring"`, `"standard"`) and `result` (`"success"`, `"failure"`).
 
-##### Guidelines
+#### Guidelines
 
 Try to come up with meaningful metrics to cover your feature with when developing it. Refer to [Prometheus best practices][1] when naming your metric and labels.
 

{flagsmith_common-2.2.7 → flagsmith_common-3.1.0}/pyproject.toml

@@ -1,27 +1,32 @@
 [project]
 name = "flagsmith-common"
-version = "2.2.7"
+version = "3.1.0"
 description = "Flagsmith's common library"
 requires-python = ">=3.11,<4.0"
-dependencies = [
-    "backoff (>=2.2.1,<3.0.0)",
-    "django (>4,<5)",
+dependencies = []
+optional-dependencies = { test-tools = [
+    "pyfakefs (>=5,<6)",
+    "pytest-django (>=4,<5)",
+], common-core = [
+    "django (>4,<6)",
     "django-health-check",
     "djangorestframework-recursive",
     "djangorestframework",
     "drf-writable-nested",
     "drf-yasg (>=1.21.10,<2.0.0)",
     "environs (<15)",
-    "flagsmith-flag-engine",
     "gunicorn (>=19.1)",
     "prometheus-client (>=0.0.16)",
     "psycopg2-binary (>=2.9,<3)",
     "requests",
     "simplejson (>=3,<4)",
-]
-optional-dependencies = { test-tools = [
-    "pyfakefs (>=5,<6)",
-    "pytest-django (>=4,<5)",
+], task-processor = [
+    "backoff (>=2.2.1,<3.0.0)",
+    "django (>4,<6)",
+    "django-health-check",
+    "prometheus-client (>=0.0.16)",
+], flagsmith-schemas = [
+    "typing_extensions",
 ] }
 authors = [
     { name = "Matthew Elwell" },
@@ -37,7 +42,12 @@ maintainers = [{ name = "Flagsmith Team", email = "support@flagsmith.com" }]
 license = "BSD-3-Clause"
 license-files = ["LICENSE"]
 readme = "README.md"
-dynamic = ["classifiers"]
+classifiers = [
+    "Framework :: Django",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+]
 
 [project.urls]
 Changelog = "https://github.com/flagsmith/flagsmith-common/blob/main/CHANGELOG.md"
@@ -52,41 +62,33 @@ flagsmith = "common.core.main:main"
 [project.entry-points.pytest11]
 flagsmith-test-tools = "common.test_tools.plugin"
 
-[tool.poetry]
-requires-poetry = ">=2.0"
-classifiers = [
-    "Framework :: Django",
-    "Framework :: Pytest",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: BSD License",
+[dependency-groups]
+dev = [
+    "dj-database-url (>=2.3.0, <3.0.0)",
+    "django-stubs (>=5.1.3, <6.0.0)",
+    "djangorestframework-stubs (>=3.15.3, <4.0.0)",
+    "mypy (>=1.15.0, <2.0.0)",
+    "pre-commit",
+    "pydantic>=2.12.5",
+    "pyfakefs (>=5.7.4, <6.0.0)",
+    "pytest (>=8.3.4, <9.0.0)",
+    "pytest-asyncio (>=0.25.3, <1.0.0)",
+    "pytest-cov (>=6.0.0, <7.0.0)",
+    "pytest-django (>=4.10.0, <5.0.0)",
+    "pytest-freezegun (>=0.4.2, <1.0.0)",
+    "pytest-httpserver (>=1.1.3, <2.0.0)",
+    "pytest-mock (>=3.14.0, <4.0.0)",
+    "setuptools (>=78.1.1, <79.0.0)",
+    "types-python-dateutil (>=2.9.0.20250516, <3.0.0)",
+    "types-simplejson (>=3.20.0.20250326, <4.0.0)",
 ]
-packages = [
-    { include = "common", from = "src" },
-    { include = "task_processor", from = "src" },
-]
-
-[tool.poetry.group.dev.dependencies]
-dj-database-url = "^2.3.0"
-django-stubs = "^5.1.3"
-djangorestframework-stubs = "^3.15.3"
-mypy = "^1.15.0"
-pre-commit = "*"
-pyfakefs = "^5.7.4"
-pytest = "^8.3.4"
-pytest-asyncio = "^0.25.3"
-pytest-cov = "^6.0.0"
-pytest-django = "^4.10.0"
-pytest-freezegun = "^0.4.2"
-pytest-httpserver = "^1.1.3"
-pytest-mock = "^3.14.0"
-ruff = "==0.11.9"
-setuptools = "^78.1.1"
-types-simplejson = "^3.20.0.20250326"
-types-python-dateutil = "^2.9.0.20250516"
 
 [build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["common", "task_processor", "flagsmith_schemas"]
 
 [tool.coverage.report]
 # Regexes for lines to exclude from consideration

{flagsmith_common-2.2.7 → flagsmith_common-3.1.0}/src/common/test_tools/plugin.py

@@ -1,11 +1,7 @@
 from functools import partial
-from typing import Generator
+from typing import TYPE_CHECKING, Generator
 
-import prometheus_client
 import pytest
-from prometheus_client.metrics import MetricWrapperBase
-from pyfakefs.fake_filesystem import FakeFilesystem
-from pytest_django.fixtures import SettingsWrapper
 
 from common.test_tools.types import (
     AssertMetricFixture,
@@ -15,6 +11,10 @@ from common.test_tools.types import (
 )
 from task_processor.task_run_method import TaskRunMethod
 
+if TYPE_CHECKING:
+    from pyfakefs.fake_filesystem import FakeFilesystem
+    from pytest_django.fixtures import SettingsWrapper
+
 
 def pytest_addoption(parser: pytest.Parser) -> None:
     group = parser.getgroup("snapshot")
@@ -26,12 +26,14 @@ def pytest_addoption(parser: pytest.Parser) -> None:
 
 
 def assert_metric_impl() -> Generator[AssertMetricFixture, None, None]:
+    import prometheus_client
+
     registry = prometheus_client.REGISTRY
     collectors = [*registry._collector_to_names]
 
     # Reset registry state
     for collector in collectors:
-        if isinstance(collector, MetricWrapperBase):
+        if isinstance(collector, prometheus_client.metrics.MetricWrapperBase):
             collector.clear()
 
     def _assert_metric(
@@ -53,7 +55,7 @@ assert_metric = pytest.fixture(assert_metric_impl)
 
 
 @pytest.fixture()
-def saas_mode(fs: FakeFilesystem) -> Generator[None, None, None]:
+def saas_mode(fs: "FakeFilesystem") -> Generator[None, None, None]:
     from common.core.utils import is_saas
 
     is_saas.cache_clear()
@@ -65,7 +67,7 @@ def saas_mode(fs: FakeFilesystem) -> Generator[None, None, None]:
 
 
 @pytest.fixture()
-def enterprise_mode(fs: FakeFilesystem) -> Generator[None, None, None]:
+def enterprise_mode(fs: "FakeFilesystem") -> Generator[None, None, None]:
     from common.core.utils import is_enterprise
 
     is_enterprise.cache_clear()
@@ -77,7 +79,7 @@ def enterprise_mode(fs: FakeFilesystem) -> Generator[None, None, None]:
 
 
 @pytest.fixture()
-def task_processor_mode(settings: SettingsWrapper) -> None:
+def task_processor_mode(settings: "SettingsWrapper") -> None:
     settings.TASK_PROCESSOR_MODE = True
     # The setting is supposed to be set before the metrics module is imported,
     # so reload it
@@ -101,7 +103,7 @@ def flagsmith_markers_marked(
 
 @pytest.fixture(name="run_tasks")
 def run_tasks_impl(
-    settings: SettingsWrapper,
+    settings: "SettingsWrapper",
     transactional_db: None,
     task_processor_mode: None,
 ) -> RunTasksFixture:

flagsmith_common-3.1.0/src/flagsmith_schemas/constants.py

@@ -0,0 +1,4 @@
+from importlib.util import find_spec
+
+PYDANTIC_INSTALLED = find_spec("pydantic") is not None
+MAX_STRING_FEATURE_STATE_VALUE_LENGTH = 20_000