Feat/v1.1.5 (#8)

Author: dsun0720

.github/workflows/code-quality.yaml

@@ -0,0 +1,39 @@
+name: Python Linting and Testing
+
+on: 
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  build:
+    # compatible for py 3.6
+    runs-on: ubuntu-20.04
+    strategy:
+      # You can use PyPy versions in python-version.
+      matrix:
+        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest pytest-mock
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors
+          flake8 .
+      - name: Test with pytest
+        run: |
+          pytest

.github/workflows/release.yaml

@@ -0,0 +1,59 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Upload Python Package
+
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment: py-production
+    steps:
+      - uses: actions/checkout@v3
+      - name: Read current version
+        id: version
+        uses: juliangruber/read-file-action@v1.1
+        with:
+          path: ./release/package.json
+          property: version
+      - name: Read realease description
+        id: description
+        uses: juliangruber/read-file-action@v1.1.6
+        with:
+          path: ./release/description.md
+      - name: Create GitHub Release
+        uses: actions/create-release@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.PROJECT_RELEASE_TOKEN }}
+        with:
+            tag_name: v${{steps.version.outputs.value}}
+            release_name: v${{steps.version.outputs.value}}
+            body: ${{steps.description.outputs.content}}
+            draft: false
+            prerelease: false
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.6
+        with:
+          user: featbit
+          password: ${{ secrets.PYPI_PASSWORD }}

MANIFEST.in

@@ -1,3 +1,4 @@
 include requirements.txt
 include README.md
-include dev-requirements.txt
+include dev-requirements.txt
+include release/package.json

README.md

@@ -144,7 +144,13 @@ If you would like to get variations of all feature flags in a special environmen
 if client.initialize:
     user = {'key': user_key, 'name': user_name}
     all_flag_values = client.get_all_latest_flag_variations(user)
-    detail = all_flag_values.get(flag_key, default=None)
+    # get all feature flag keys
+    keys = all_flag_values.keys()
+    for flag_key in keys:
+        # get viariation detail
+        detail = all_flag_values.get(flag_key, default=None)
+        # get viariation
+        value = all_flag_values.get_variation(flag_key, default=None)
 ```
 
 > **Note**

fbclient/common_types.py

@@ -215,6 +215,24 @@ def __init__(self, success: bool, reason: str,
         self._data = dict((ed.key_name, (ed, fb_event)) for ed, fb_event in data.items()) if data else {}
         self._event_handler = event_handler
 
+    def keys(self):
+        """
+        return all feature flag keys
+        """
+        return self._data.keys()
+
+    def get_variation(self, key_name: str, default: Any = None) -> Any:
+        """Return the variation of a given feature flag key
+
+        This method will send event to back to feature flag center immediately
+
+        The default value should be a string, boolean, numeric, or json type.
+
+        :param key_name: key name of the flag
+        :return: the variation of the flag in any type of string, boolean, numeric, or json type
+        """
+        return self.get(key_name, default).variation
+
     def get(self, key_name: str, default: Any = None) -> EvalDetail:
         """Return the flag evaluation details of a given feature flag key
 

fbclient/version.py

@@ -1 +1 @@
-VERSION = "1.1.4"
+VERSION = "1.1.5"

release/description.md

@@ -0,0 +1,14 @@
+
+version: 1.1.5
+
+## Break changes
+
+No Break changes
+
+## New features
+
+No new features
+
+## Updates
+
+- optimize `AllFlagStates` in adding two functions: `keys` and `get_variation`

release/package.json

@@ -0,0 +1,3 @@
+{
+    "version":"1.1.5"
+}

setup.py

@@ -1,12 +1,11 @@
+import json
 from setuptools import setup, find_packages
 
-version = {}
-
 
 def last_version():
-    with open("./fbclient/version.py") as fp:
-        exec(fp.read(), version)
-    return version['VERSION']
+    with open("./release/package.json") as fp:
+        version = json.load(fp)
+    return version['version']
 
 
 fb_version = last_version()

tests/test_fbclient.py

@@ -206,15 +206,30 @@ def test_get_all_latest_flag_variations():
         assert client.initialize
         all_states = client.get_all_latest_flag_variations(USER_1)
         ed = all_states.get("ff-test-bool", False)
+        value = all_states.get_variation("ff-test-bool", False)
         assert ed is not None and ed.variation is True
+        assert value is True
+        assert "ff-test-bool" in all_states.keys()
         ed = all_states.get("ff-test-number", -1)
+        value = all_states.get_variation("ff-test-number", -1)
         assert ed is not None and ed.variation == 1
+        assert value == 1
+        assert "ff-test-number" in all_states.keys()
         ed = all_states.get("ff-test-string", 'error')
+        value = all_states.get_variation("ff-test-string", 'error')
         assert ed is not None and ed.variation == "others"
+        assert value == "others"
+        assert "ff-test-string" in all_states.keys()
         ed = all_states.get("ff-test-seg", 'error')
+        value = all_states.get_variation("ff-test-seg", 'error')
         assert ed is not None and ed.variation == "teamA"
+        assert value == "teamA"
+        assert "ff-test-seg" in all_states.keys()
         ed = all_states.get("ff-test-json", {})
+        value = all_states.get_variation("ff-test-json", {})
         assert ed is not None and ed.variation["code"] == 200
+        assert value["code"] == 200
+        assert "ff-test-json" in all_states.keys()
 
 
 def test_variation_argument_error():