Skip to content

Commit

Permalink
Merge pull request #12523 from lovetheguitar/fix/follow_up_to_pr_#12500
Browse files Browse the repository at this point in the history
Improve documentation & other kinks of marker keyword expression PR #12500
  • Loading branch information
The-Compiler authored Jun 25, 2024
2 parents 2b7eadf + 36b384a commit 53bf188
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 8 deletions.
2 changes: 1 addition & 1 deletion doc/en/example/markers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ keyword arguments, e.g. to run only tests marked with ``device`` and the specifi

.. code-block:: pytest
$ pytest -v -m 'device(serial="123")'
$ pytest -v -m "device(serial='123')"
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y -- $PYTHON_PREFIX/bin/python
cachedir: .pytest_cache
Expand Down
2 changes: 1 addition & 1 deletion doc/en/how-to/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ with the ``phase`` keyword argument set to ``1``:

.. code-block:: bash
pytest -m slow(phase=1)
pytest -m "slow(phase=1)"
For more information see :ref:`marks <mark>`.

Expand Down
10 changes: 7 additions & 3 deletions src/_pytest/mark/expression.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@
expression: expr? EOF
expr: and_expr ('or' and_expr)*
and_expr: not_expr ('and' not_expr)*
not_expr: 'not' not_expr | '(' expr ')' | ident ( '(' name '=' value ( ', ' name '=' value )* ')')*
not_expr: 'not' not_expr | '(' expr ')' | ident kwargs?
ident: (\w|:|\+|-|\.|\[|\]|\\|/)+
kwargs: ('(' name '=' value ( ', ' name '=' value )* ')')
name: a valid ident, but not a reserved keyword
value: (unescaped) string literal | (-)?[0-9]+ | 'False' | 'True' | 'None'
The semantics are:
- Empty expression evaluates to False.
- ident evaluates to True of False according to a provided matcher function.
- ident evaluates to True or False according to a provided matcher function.
- or/and/not evaluate according to the usual boolean semantics.
- ident with parentheses and keyword arguments evaluates to True or False according to a provided matcher function.
"""

from __future__ import annotations
Expand Down Expand Up @@ -48,7 +52,7 @@ class TokenType(enum.Enum):
IDENT = "identifier"
EOF = "end of input"
EQUAL = "="
STRING = "str"
STRING = "string literal"
COMMA = ","


Expand Down
2 changes: 1 addition & 1 deletion testing/test_mark.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def test_two():

@pytest.mark.parametrize(
("expr", "expected_passed"),
[ # TODO: improve/sort out
[
("car(color='red')", ["test_one"]),
("car(color='red') or car(color='blue')", ["test_one", "test_two"]),
("car and not car(temp=5)", ["test_one", "test_three"]),
Expand Down
5 changes: 3 additions & 2 deletions testing/test_mark_expression.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,10 @@ def test_invalid_idents(ident: str) -> None:
r'escaping with "\\" not supported in marker expression',
),
("mark(empty_list=[])", r'unexpected character/s "\[\]"'),
("'str'", "expected not OR left parenthesis OR identifier; got string literal"),
),
)
def test_invalid_kwarg_name_or_value( # TODO: move to `test_syntax_errors` ?
def test_invalid_kwarg_name_or_value(
expr: str, expected_error_msg: str, mark_matcher: MarkMatcher
) -> None:
with pytest.raises(ParseError, match=expected_error_msg):
Expand Down Expand Up @@ -289,7 +290,7 @@ def test_keyword_expressions_with_numbers(
("builtin_matchers_mark(z=1)", False),
),
)
def test_builtin_matchers_keyword_expressions( # TODO: naming when decided
def test_builtin_matchers_keyword_expressions(
expr: str, expected: bool, mark_matcher: MarkMatcher
) -> None:
assert evaluate(expr, mark_matcher) is expected
Expand Down

0 comments on commit 53bf188

Please sign in to comment.