UPDATE TO: behave v1.2.7.dev6

jenisys · jenisys · commit 44fe34357aa6 · 2024-09-25T07:01:23.000+02:00
* Adapt steps that need trailing colon now (use: ctx.table, ctx.text)
* environment.py: Show enviroment contet from active_tag.values
* USE: .envrc.use_venv for auto-setup a virtual environment
diff --git a/.envrc b/.envrc
@@ -1,16 +1,31 @@
 # ===========================================================================
-# PROJECT ENVIRONMENT SETUP: behave.example/.envrc
+# PROJECT ENVIRONMENT SETUP: .envrc
 # ===========================================================================
 # SHELL: bash (or similiar)
-# SEE ALSO: https://direnv.net/
+# REQUIRES: direnv >= 2.21.0  -- NEEDED FOR: path_add, venv support
 # USAGE:
-#   source .envrc
-#
-#   # -- BETTER: Use direnv (requires: Setup in bash / HOME/.bashrc)
-#   # eval "$(direnv hook bash)"
+#   # -- BETTER: Use direnv (requires: Setup in bash -- $HOME/.bashrc)
+#   # BASH PROFILE NEEDS: eval "$(direnv hook bash)"
 #   direnv allow .
+#
+# SEE ALSO:
+#   * https://direnv.net/
+#   * https://github.com/direnv/direnv
+#   * https://peps.python.org/pep-0582/   Python local packages directory
 # ===========================================================================
+# MAYBE: HERE="${PWD}"
+
+# -- USE OPTIONAL PARTS (if exist/enabled):
+# REQUIRES: direnv >= 2.26.0  -- NEEDED FOR: dotenv_if_exists
+# DISABLED: dotenv_if_exists .env
+source_env_if_exists .envrc.use_venv
 
 export TOPDIR="$PWD"
-export PYTHONPATH=".:$TOPDIR:$TOPDIR/lib/python:${PYTHONPATH}"
-export PATH=".:$TOPDIR/bin:$PATH"
+
+# -- SETUP-PYTHON: Prepend ${HERE} to PYTHONPATH (as PRIMARY search path)
+# SIMILAR TO: export PYTHONPATH="${HERE}:${PYTHONPATH}"
+path_add PYTHONPATH lib/python
+path_add PYTHONPATH .
+path_add PATH bin
+
+source_env_if_exists .envrc.override
diff --git a/.envrc.use_venv b/.envrc.use_venv
@@ -0,0 +1,22 @@
+# ===========================================================================
+# PROJECT ENVIRONMENT SETUP: .envrc.use_venv
+# ===========================================================================
+# REQUIRES: direnv >= 2.21.0  -- NEEDED FOR: venv support
+# DESCRIPTION:
+#   Setup and use a Python virtual environment (venv).
+#   On entering the directory: Creates and activates a venv for a python version.
+#   On leaving  the directory: Deactivates the venv (virtual environment).
+#
+# ENABLE/DISABLE THIS OPTIONAL PART:
+#   * TO ENABLE:  Rename ".envrc.use_venv.disabled" to ".envrc.use_venv"
+#   * TO DISABLE: Rename ".envrc.use_venv" to ".envrc.use_venv.disabled"
+#
+# SEE ALSO:
+#   * https://direnv.net/
+#   * https://github.com/direnv/direnv/wiki/Python
+#   * https://direnv.net/man/direnv-stdlib.1.html#codelayout-python-ltpythonexegtcode
+# ===========================================================================
+
+# -- VIRTUAL ENVIRONMENT SUPPORT: layout python python3
+# VENV LOCATION: .direnv/python-$(PYTHON_VERSION)
+layout python python3
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@
 *.pyo
 .DS_Store
 .coverage
+.direnv/
 .idea/
 .tox/
 .venv*/
diff --git a/datatype.features/environment.py b/datatype.features/environment.py
@@ -1,4 +1,38 @@
-# -*- coding: utf--8 -*-
+# -*- coding: UTF-8 -*-
+
+import behave.active_tag.python
+import behave.active_tag.python_feature
+from behave.fixture import use_fixture_by_tag
+from behave.tag_matcher import (
+    ActiveTagMatcher, setup_active_tag_values, print_active_tags
+)
+
+
+# -----------------------------------------------------------------------------
+# ACTIVE TAGS:
+# -----------------------------------------------------------------------------
+# -- MATCHES ANY TAGS: @use.with_{category}={value}
+# NOTE: active_tag_value_provider provides category values for active tags.
+active_tag_value_provider = {}
+active_tag_value_provider.update(behave.active_tag.python.ACTIVE_TAG_VALUE_PROVIDER)
+active_tag_value_provider.update(behave.active_tag.python_feature.ACTIVE_TAG_VALUE_PROVIDER)
+active_tag_matcher = ActiveTagMatcher(active_tag_value_provider)
+
+
+def print_active_tags_summary():
+    print_active_tags(active_tag_value_provider, ["python.version", "os"])
+
+
+# -----------------------------------------------------------------------------
 # -- SETUP: Use cfparse as default matcher
+# -----------------------------------------------------------------------------
 from behave import use_step_matcher
 use_step_matcher("cfparse")
+
+
+# -----------------------------------------------------------------------------
+# HOOKS:
+# -----------------------------------------------------------------------------
+def before_all(context):
+    context.config.setup_logging()
+    print_active_tags_summary()
diff --git a/datatype.features/steps/step_cardinality_one_or_more.py b/datatype.features/steps/step_cardinality_one_or_more.py
@@ -80,7 +80,7 @@ def step_when_I_meet_person_and_more(context, persons):
 def step_given_I_go_to_meeting(context):
     context.meeting = Meeting()
 
-@then('the following persons are present')
+@then('the following persons are present:')
 def step_following_persons_are_present(context):
     assert context.table, "table<Person> is required"
     actual_persons   = sorted(context.meeting.persons)
diff --git a/datatype.features/steps/step_cardinality_zero_or_more.py b/datatype.features/steps/step_cardinality_zero_or_more.py
@@ -78,7 +78,7 @@ def step_given_I_am_a_painter(context):
 def step_then_no_colors_are_used(context):
     assert_that(context.used_colors, has_length(0))
 
-@then('the following colors are used')
+@then('the following colors are used:')
 def step_then_following_colors_are_used(context):
     assert context.table, "table<color> is required"
     used_colors     = sorted(context.used_colors)
diff --git a/features/environment.py b/features/environment.py
@@ -1,24 +1,58 @@
 # -*- coding: UTF-8 -*-
 """
-before_step(context, step), after_step(context, step)
-    These run before and after every step.
-    The step passed in is an instance of Step.
+.. code::
 
-before_scenario(context, scenario), after_scenario(context, scenario)
-    These run before and after each scenario is run.
-    The scenario passed in is an instance of Scenario.
+    # -- HOOKS:
+    before_step(context, step), after_step(context, step)
+        These run before and after every step.
+        The step passed in is an instance of Step.
 
-before_feature(context, feature), after_feature(context, feature)
-    These run before and after each feature file is exercised.
-    The feature passed in is an instance of Feature.
+    before_scenario(context, scenario), after_scenario(context, scenario)
+        These run before and after each scenario is run.
+        The scenario passed in is an instance of Scenario.
 
-before_tag(context, tag), after_tag(context, tag)
+    before_feature(context, feature), after_feature(context, feature)
+        These run before and after each feature file is exercised.
+        The feature passed in is an instance of Feature.
 
+    before_tag(context, tag), after_tag(context, tag)
+        These run before and after any new tag of a model-element.
 """
 
+
+import behave.active_tag.python
+import behave.active_tag.python_feature
+from behave.fixture import use_fixture_by_tag
+from behave.tag_matcher import (
+    ActiveTagMatcher, setup_active_tag_values, print_active_tags
+)
+
+
+# -----------------------------------------------------------------------------
+# ACTIVE TAGS:
+# -----------------------------------------------------------------------------
+# -- MATCHES ANY TAGS: @use.with_{category}={value}
+# NOTE: active_tag_value_provider provides category values for active tags.
+active_tag_value_provider = {}
+active_tag_value_provider.update(behave.active_tag.python.ACTIVE_TAG_VALUE_PROVIDER)
+active_tag_value_provider.update(behave.active_tag.python_feature.ACTIVE_TAG_VALUE_PROVIDER)
+active_tag_matcher = ActiveTagMatcher(active_tag_value_provider)
+
+
+def print_active_tags_summary():
+    print_active_tags(active_tag_value_provider, ["python.version", "os"])
+
+
+# -----------------------------------------------------------------------------
 # -- SETUP: Use cfparse as default matcher
+# -----------------------------------------------------------------------------
 # from behave import use_step_matcher
-# step_matcher("cfparse")
+# use_step_matcher("cfparse")
+
 
+# -----------------------------------------------------------------------------
+# HOOKS:
+# -----------------------------------------------------------------------------
 def before_all(context):
     context.config.setup_logging()
+    print_active_tags_summary()
diff --git a/features/steps/step_tutorial05.py b/features/steps/step_tutorial05.py
@@ -44,7 +44,7 @@ def seems_like_language(self):
 from behave   import given, when, then
 from hamcrest import assert_that, equal_to
 
-@given('a sample text loaded into the frobulator')
+@given('a sample text loaded into the frobulator:')
 def step_impl(context):
     frobulator = getattr(context, "frobulator", None)
     if not frobulator:
diff --git a/features/steps/step_tutorial06.py b/features/steps/step_tutorial06.py
@@ -25,7 +25,7 @@
 from testutil import NamedNumber
 from company_model import CompanyModel
 
-@given('a set of specific users')
+@given('a set of specific users:')
 def step_impl(context):
     model = getattr(context, "model", None)
     if not model:
diff --git a/features/steps/step_tutorial07.py b/features/steps/step_tutorial07.py
@@ -43,7 +43,7 @@
 from hamcrest.library.collection.issequence_containinginanyorder \
     import contains_inanyorder
 
-@then('we will have the following people in "{department}"')
+@then('we will have the following people in "{department}":')
 def step_impl(context, department):
     """
     Compares expected with actual persons in a department.
@@ -59,7 +59,7 @@ def step_impl(context, department):
     # -- UNORDERED TABLE-COMPARISON (using: pyhamcrest)
     assert_that(contains_inanyorder(*expected_persons), actual_persons)
 
-@then('we will have at least the following people in "{department}"')
+@then('we will have at least the following people in "{department}":')
 def step_impl(context, department):
     """
     Compares subset of persons with actual persons in a department.
diff --git a/invoke.yaml b/invoke.yaml
@@ -20,4 +20,4 @@ behave_test:
       - datatype.features
       - step_matcher.features
     args: features datatype.features step_matcher.features
-
+    format: progress3
diff --git a/py.requirements/all.txt b/py.requirements/all.txt
@@ -1,10 +1,11 @@
 # ============================================================================
-# PYTHON PACKAGE REQUIREMENTS: basic
+# PYTHON PACKAGE REQUIREMENTS: all
 # ============================================================================
-# REQUIRES: Python >= 2.7
+# REQUIRES: Python >= 2.7  (better: 3.x by now)
 # DESCRIPTION:
 #    pip install -r <THIS_FILE>
 # ============================================================================
 
 -r basic.txt
+-r behave_ext.txt
 -r develop.txt
diff --git a/py.requirements/basic.txt b/py.requirements/basic.txt
@@ -4,20 +4,29 @@
 # REQUIRES: Python >= 2.7
 # DESCRIPTION:
 #    pip install -r <THIS_FILE>
+#
+# SEE ALSO:
+#  * https://pip.pypa.io/en/stable/user_guide/
 # ============================================================================
 
 # -- BEHAVE-RELATED:
 # behave >= 1.2.6
-git+https://github.com/behave/behave.git@v1.2.7.dev1
+# git+https://github.com/behave/behave.git@v1.2.7.dev6
+behave == 1.2.7.dev6
 
 PyHamcrest <2.0.0;    python_version <  '3.5'
 PyHamcrest >= 2.0.2;  python_version >= '3.5'
 -r behave_ext.txt
 
-# -- MAYBE: behave requirements
-traceback2 >= 1.4.0;    python_version <= '3.0'
+enum34; python_version < '3.4'
 parse >= 1.18.0
-parse_type >= 0.5.2
+parse_type >= 0.6.0
 
+# -- MAYBE: behave requirements
+# traceback2 >= 1.4.0;    python_version < '3.0'
+traceback2;  python_version < '3.0'
+contextlib2; python_version < '3.5'
+win_unicode_console >= 0.5;  python_version < '3.6'
+colorama >= 0.3.7
 # -- UNCLEAR WHY:
 # argparse;  python_version <= '3.3'
diff --git a/py.requirements/develop.txt b/py.requirements/develop.txt
@@ -9,15 +9,15 @@
 # -- BUILD-SUPPORT: invoke >= 1.2.0
 -r ../tasks/py.requirements.txt
 
-tox >= 3.10.0
+tox >= 3.13.0
 pylint
-twine
-modernize
+twine >= 1.13.0
+modernize >= 0.5
 
 # -- DISABLED:
 # watchdog >= 0.6.0
 
 # -- DEPENDS ON:
 -r basic.txt
--r docs.txt
 -r testing.txt
+-r docs.txt
diff --git a/py.requirements/docs.txt b/py.requirements/docs.txt
@@ -23,15 +23,57 @@
 #
 # MAYBE: bootstrap4
 
-sphinx >=2.0
+sphinx >= 7.3.7;   python_version >= '3.7'
+sphinx >=1.6,<4.4; python_version < '3.7'
 sphinx-autobuild
-sphinx_bootstrap_theme >= 0.6.0
 
 sphinxcontrib-programoutput >=0.8,<0.10.0
 git+https://github.com/jenisys/sphinxcontrib-ansi.git@JE_v0.7.0
 
+
+# -- SPHINX-THEMES:
+# SEE: https://www.sphinx-doc.org/en/master/usage/theming.html
+# SEE: https://sphinx-themes.org
+furo >= 2024.04.27; python_version >= '3.8'
+# DISABLED: sphinx-nefertiti >= 0.3.3; python_version >= '3.9'
+# DISABLED: sphinx_bootstrap_theme >= 0.6.0
+
+# -- SPHINX-EXTENSIONS:
+# SPHINX-COPYBUTTON:
+#   SEE: https://github.com/executablebooks/sphinx-copybutton
+sphinx-copybutton >= 0.5.2; python_version >= '3.7'
+
+# -- NEEDED FOR: RTD (as temporary fix)
+urllib3 < 2.0.0; python_version < '3.8'
+
 # -- SUPPORT: sphinx-doc translations (prepared)
 sphinx-intl >= 0.9.11
 
+# -- CONSTRAINTS UNTIL: sphinx > 5.0 can be used
+# PROBLEM: sphinxcontrib-applehelp v1.0.8 requires sphinx > 5.0
+# SEE: https://stackoverflow.com/questions/77848565/sphinxcontrib-applehelp-breaking-sphinx-builds-with-sphinx-version-less-than-5-0
+# DISABLED: sphinxcontrib-applehelp==1.0.4; python_version >= '3.7'
+# DISABLED: sphinxcontrib-devhelp==1.0.2;   python_version >= '3.7'
+# DISABLED: sphinxcontrib-htmlhelp==2.0.1;  python_version >= '3.7'
+# DISABLED: sphinxcontrib-qthelp==1.0.3;    python_version >= '3.7'
+# DISABLED: sphinxcontrib-serializinghtml==1.1.5; python_version >= '3.7'
+
+sphinxcontrib-applehelp >= 1.0.8; python_version >= '3.7'
+sphinxcontrib-htmlhelp >= 2.0.5;  python_version >= '3.7'
+
 # -- OPTIONAL DOCUMENTATION: If PDF docs are needed.
 # rst2pdf
+
+
+# ---------------------------------------------------------------------------
+# DOCUMENTATION WRITING HELPERS:
+# ---------------------------------------------------------------------------
+# SEE: https://github.com/codespell-project/codespell
+codespell >= 2.3.0; python_version >= '3.8'
+
+
+# ---------------------------------------------------------------------------
+# EXPERIMENTAL:
+# ---------------------------------------------------------------------------
+# SEE: https://github.com/amperser/proselint
+proselint >= 0.14.0; python_version >= '3.8'
diff --git a/py.requirements/testing.txt b/py.requirements/testing.txt
@@ -7,3 +7,7 @@
 # ============================================================================
 
 -r basic.txt
+# -- ASSERT-MATCHERS:
+PyHamcrest >= 2.0.2; python_version >= '3.0'
+PyHamcrest <  2.0;   python_version <  '3.0'
+assertpy >= 1.1
diff --git a/step_matcher.features/environment.py b/step_matcher.features/environment.py
diff --git a/tasks/__init__.py b/tasks/__init__.py
diff --git a/tasks/_path.py b/tasks/_path.py
diff --git a/tasks/_setup.py b/tasks/_setup.py
diff --git a/tasks/docs.py b/tasks/docs.py
diff --git a/tasks/py.requirements.txt b/tasks/py.requirements.txt
diff --git a/tasks/test.py b/tasks/test.py
