Updates to Python Feature Management

.github/copilot-instructions.md

@@ -0,0 +1,56 @@
+# Copilot Instructions
+
+## Python Environment
+
+Always activate and use the Python virtual environment when running Python commands:
+
+- On Windows: `.venv\Scripts\activate`
+- On Linux/macOS: `source .venv/bin/activate`
+
+Use `python -m pip` instead of bare `pip` when installing packages.
+
+## Dev Setup
+
+Install all dependencies with:
+
+```
+python -m pip install -e ".[dev,test]"
+```
+
+## Python Version
+
+This project requires Python 3.10 or newer.
+
+## Project Structure
+
+- `featuremanagement/` — Synchronous feature management code
+- `featuremanagement/aio/` — Async equivalents of feature management classes
+- `featuremanagement/_models/` — Data models (feature flags, variants, telemetry)
+- `featuremanagement/_time_window_filter/` — Time window filter with recurrence support
+- `featuremanagement/azuremonitor/` — Optional Azure Monitor telemetry integration
+- `tests/` — Unit tests (sync and async)
+- `samples/` — Sample applications
+
+## Code Conventions
+
+- All source files must include the Microsoft copyright header.
+- All modules must have a module-level docstring.
+- Maximum line length is 120 characters.
+- Use type annotations on all functions and methods.
+
+## Code Quality
+
+Run these before submitting changes:
+
+```
+black featuremanagement
+pylint featuremanagement
+mypy featuremanagement
+pytest tests
+```
+
+## Testing
+
+- Sync tests are in `tests/test_*.py`
+- Async tests use `pytest-asyncio` and are in files ending with `_async.py`
+- Run tests with: `pytest tests`

.github/workflows/validate.yml

@@ -17,8 +17,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r dev_requirements.txt
-        pip install .
+        pip install ".[dev]"
     - name: Analysing the code with pylint
       run: |
         pylint featuremanagement
@@ -30,7 +29,7 @@ jobs:
       uses: streetsidesoftware/cspell-action@v6.8.0
     - name: Test with pytest
       run: |
-        pip install -r tests/requirements.txt
+        pip install ".[test]"
         pytest tests --doctest-modules --cov-report=xml --cov-report=html
     - name: Analysing the samples with pylint
       run: |

cspell.config.yaml

@@ -12,7 +12,7 @@ ignorePaths:
   - '.*'
   - 'build'
   - 'docs'
-  - 'dev_requirements.txt'
+  - 'node_modules'
   - '*.egg-info'
   - '*.ini'
   - '*.toml'

featuremanagement/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Feature management library for Python."""
+
 from ._featuremanager import FeatureManager
 from ._featurefilters import FeatureFilter
 from ._defaultfilters import TimeWindowFilter, TargetingFilter

featuremanagement/_defaultfilters.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Built-in feature filter implementations."""
+
 import logging
 import hashlib
 from datetime import datetime, timezone

featuremanagement/_featurefilters.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Base class for feature filters."""
+
 from abc import ABC, abstractmethod
 from typing import Mapping, Callable, Any, Optional
 

featuremanagement/_featuremanager.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Synchronous feature manager implementation."""
+
 import logging
 from typing import cast, overload, Any, Optional, Dict, Mapping, List, Tuple
 from ._defaultfilters import TimeWindowFilter, TargetingFilter

featuremanagement/_featuremanagerbase.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Base class for feature manager implementations."""
+
 import hashlib
 import logging
 from abc import ABC

featuremanagement/_models/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Data models for feature management."""
+
 from ._feature_flag import FeatureFlag
 from ._variant import Variant
 from ._evaluation_event import EvaluationEvent

featuremanagement/_models/_allocation.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Allocation model for feature variant assignment."""
+
 from typing import cast, List, Optional, Mapping, Dict, Any, Union
 from dataclasses import dataclass
 from ._constants import DEFAULT_WHEN_ENABLED, DEFAULT_WHEN_DISABLED, USER, GROUP, PERCENTILE, SEED

featuremanagement/_models/_constants.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Constants used by feature management models."""
 
 # Feature Flag
 FEATURE_FLAG_ID = "id"

featuremanagement/_models/_evaluation_event.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Evaluation event model for feature flag telemetry."""
+
 from dataclasses import dataclass
 from typing import Optional
 from ._feature_flag import FeatureFlag

featuremanagement/_models/_feature_conditions.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Feature flag condition models."""
+
 from collections.abc import Mapping
 from typing import Any, Dict, List
 from ._constants import (

featuremanagement/_models/_feature_flag.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Feature flag model."""
+
 from typing import cast, List, Union, Optional, Mapping, Any
 from ._feature_conditions import FeatureConditions
 from ._allocation import Allocation

featuremanagement/_models/_targeting_context.py

@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+"""Targeting context model for user and group targeting."""
 
 from typing import NamedTuple, List
 

featuremanagement/_models/_telemetry.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Telemetry metadata model."""
+
 from typing import Dict
 from dataclasses import dataclass, field
 

featuremanagement/_models/_variant.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Variant model representing a feature flag variant."""
+
 from typing import Any
 
 

featuremanagement/_models/_variant_assignment_reason.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Enum for variant assignment reasons."""
+
 from enum import Enum
 
 

featuremanagement/_models/_variant_reference.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Variant reference model."""
+
 from dataclasses import dataclass
 from typing import Optional, Mapping, Any
 from ._constants import VARIANT_REFERENCE_NAME, CONFIGURATION_VALUE, STATUS_OVERRIDE

featuremanagement/_time_window_filter/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Time window filter with recurrence support."""
+
 from ._recurrence_evaluator import is_match
 from ._models import Recurrence, TimeWindowFilterSettings
 

featuremanagement/_time_window_filter/_models.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Data models for the time window filter."""
+
 from enum import Enum
 from typing import Dict, Any, Optional, List
 from datetime import datetime

featuremanagement/_time_window_filter/_recurrence_evaluator.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Recurrence evaluation logic for the time window filter."""
+
 from datetime import datetime, timedelta
 from typing import Optional
 from ._models import RecurrencePatternType, RecurrenceRangeType, TimeWindowFilterSettings, OccurrenceInfo, Recurrence

featuremanagement/_time_window_filter/_recurrence_validator.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Validation logic for recurrence settings."""
+
 from datetime import datetime, timedelta
 from typing import List
 from ._models import RecurrencePatternType, RecurrenceRangeType, Recurrence, RecurrencePattern, RecurrenceRange

featuremanagement/_version.py

@@ -3,5 +3,6 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Package version."""
 
 VERSION = "2.1.0"

featuremanagement/aio/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Async feature management support."""
+
 from ._featuremanager import FeatureManager
 from ._featurefilters import FeatureFilter
 from ._defaultfilters import TimeWindowFilter, TargetingFilter

featuremanagement/aio/_defaultfilters.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Built-in async feature filter implementations."""
+
 from typing import Mapping, Any
 from ._featurefilters import FeatureFilter
 from .._defaultfilters import (

featuremanagement/aio/_featurefilters.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Base class for async feature filters."""
+
 from abc import ABC, abstractmethod
 from typing import Mapping, Callable, Any, Optional
 

featuremanagement/aio/_featuremanager.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Async feature manager implementation."""
+
 import inspect
 import logging
 from typing import cast, overload, Any, Optional, Dict, Mapping, List, Tuple

featuremanagement/azuremonitor/__init__.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # -------------------------------------------------------------------------
+"""Azure Monitor telemetry integration for feature management."""
+
 from ._send_telemetry import publish_telemetry, track_event, TargetingSpanProcessor
 
 __all__ = [

featuremanagement/azuremonitor/_send_telemetry.py

@@ -3,6 +3,8 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+"""Telemetry publishing for feature evaluation events."""
+
 import logging
 import inspect
 from typing import Any, Callable, Dict, Optional

mypy.ini

@@ -1,31 +1,4 @@
 [mypy]
 python_version = 3.10
-# Start off with these
-warn_unused_configs = True
-warn_redundant_casts = True
-warn_unused_ignores = True
-
-# Getting these passing should be easy
-strict_equality = True
-extra_checks = True
-
-# Strongly recommend enabling this one as soon as you can
-check_untyped_defs = True
-
-# These shouldn't be too much additional work, but may be tricky to
-# get passing if you use a lot of untyped libraries
-disallow_subclassing_any = True
-disallow_untyped_decorators = True
-disallow_any_generics = True
-
-# These next few are various gradations of forcing use of type annotations
-disallow_untyped_calls = True
-disallow_incomplete_defs = True
-disallow_untyped_defs = True
-
-# This one isn't too hard to get passing, but return on investment is lower
-no_implicit_reexport = True
-
-# This one can be tricky to get passing if you use a lot of untyped libraries
-warn_return_any = True
+strict = True