Add a parse_semver filter #73935

JensHeinrich · 2021-03-17T14:25:03Z

SUMMARY

This filter uses the SemanticVersion class from utils.version

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

filters

ADDITIONAL INFORMATION

ansibot · 2021-03-17T14:37:55Z

The test ansible-test sanity --test pep8 [explain] failed with 9 errors:

lib/ansible/plugins/filter/core.py:345:1: E302: expected 2 blank lines, found 1
lib/ansible/plugins/filter/core.py:347:22: E231: missing whitespace after ','
lib/ansible/plugins/filter/core.py:347:30: E231: missing whitespace after ','
lib/ansible/plugins/filter/core.py:348:9: E123: closing bracket does not match indentation of opening bracket's line
lib/ansible/plugins/filter/core.py:351:11: E225: missing whitespace around operator
lib/ansible/plugins/filter/core.py:353:11: E271: multiple spaces after keyword
lib/ansible/plugins/filter/core.py:353:14: E201: whitespace after '{'
lib/ansible/plugins/filter/core.py:353:58: E202: whitespace before '}'
lib/ansible/plugins/filter/core.py:355:1: E302: expected 2 blank lines, found 1

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:353:47: SyntaxError: return  { k: semver.__getattribute__(k) for k in keys }

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:345:0: dangerous-default-value: Dangerous default value [] as argument

click here for bot help

bmillemathias · 2021-03-18T06:43:56Z

Hi @JensHeinrich

Thanks for your patch, to complete it we need also a changelog file and some tests to validate the code does not break over time, look to https://docs.ansible.com/ansible/latest/community/development_process.html#making-your-pr-merge-worthy to get an idea how to do this.

JensHeinrich · 2021-03-18T07:11:32Z

@bmillemathias on it

ansibot · 2021-03-18T07:29:19Z

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

changelogs/fragments/73935-add-semver-filter.yaml:3:1: empty-lines: too many blank lines (1 > 0)

The test ansible-test sanity --test pep8 [explain] failed with 9 errors:

lib/ansible/plugins/filter/core.py:345:1: E302: expected 2 blank lines, found 1
lib/ansible/plugins/filter/core.py:347:22: E231: missing whitespace after ','
lib/ansible/plugins/filter/core.py:347:30: E231: missing whitespace after ','
lib/ansible/plugins/filter/core.py:348:9: E123: closing bracket does not match indentation of opening bracket's line
lib/ansible/plugins/filter/core.py:351:11: E225: missing whitespace around operator
lib/ansible/plugins/filter/core.py:353:11: E271: multiple spaces after keyword
lib/ansible/plugins/filter/core.py:353:14: E201: whitespace after '{'
lib/ansible/plugins/filter/core.py:353:58: E202: whitespace before '}'
lib/ansible/plugins/filter/core.py:355:1: E302: expected 2 blank lines, found 1

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:353:47: SyntaxError: return  { k: semver.__getattribute__(k) for k in keys }

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:345:0: dangerous-default-value: Dangerous default value [] as argument

click here for bot help

bmillemathias · 2021-03-18T07:55:42Z

@bmillemathias on it

Hi, the unit / integration test is missing (test the semver filter works but also testing failure behavior)
also could you look to the errors reported by the CI tests.

Best

ansibot · 2021-03-18T10:57:17Z

The test ansible-test sanity --test pylint [explain] failed with 1 error:

test/units/plugins/filter/test_core.py:325:0: dangerous-default-value: Dangerous default value [] as argument

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:349:0: dangerous-default-value: Dangerous default value SEMVER_VALID_KEYS (builtins.list) as argument

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

changelogs/fragments/73935-add-semver-filter.yaml:3:1: empty-lines: too many blank lines (1 > 0)

The test ansible-test sanity --test pep8 [explain] failed with 79 errors:

lib/ansible/plugins/filter/core.py:345:1: E305: expected 2 blank lines after class or function definition, found 1
lib/ansible/plugins/filter/core.py:349:1: E302: expected 2 blank lines, found 1
lib/ansible/plugins/filter/core.py:352:9: E123: closing bracket does not match indentation of opening bracket's line
lib/ansible/plugins/filter/core.py:357:15: E225: missing whitespace around operator
lib/ansible/plugins/filter/core.py:357:25: E226: missing whitespace around arithmetic operator
lib/ansible/plugins/filter/core.py:366:13: E201: whitespace after '{'
lib/ansible/plugins/filter/core.py:366:57: E202: whitespace before '}'
lib/ansible/plugins/filter/core.py:368:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:11:48: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:11:61: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:78:24: E225: missing whitespace around operator
test/units/plugins/filter/test_core.py:79:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:80:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:85:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:86:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:91:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:92:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:97:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:98:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:103:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:104:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:109:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:110:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:115:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:116:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:121:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:122:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:127:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:128:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:133:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:134:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:139:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:140:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:145:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:146:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:151:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:152:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:157:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:158:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:163:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:164:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:169:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:170:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:175:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:176:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:181:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:182:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:187:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:188:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:193:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:194:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:199:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:200:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:205:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:206:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:211:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:212:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:217:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:218:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:223:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:224:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:229:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:230:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:235:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:236:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:241:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:242:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:247:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:248:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:253:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:254:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:259:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:260:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:265:9: E126: continuation line over-indented for hanging indent
test/units/plugins/filter/test_core.py:267:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:318:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:324:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:325:56: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:327:29: E231: missing whitespace after ','

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:366:46: SyntaxError: return { k: semver.__getattribute__(k) for k in keys }

click here for bot help

ansibot · 2021-03-18T11:30:07Z

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

changelogs/fragments/73935-add-semver-filter.yaml:3:1: empty-lines: too many blank lines (1 > 0)

The test ansible-test sanity --test pep8 [explain] failed with 86 errors:

lib/ansible/plugins/filter/core.py:345:1: E305: expected 2 blank lines after class or function definition, found 1
lib/ansible/plugins/filter/core.py:349:1: E302: expected 2 blank lines, found 1
lib/ansible/plugins/filter/core.py:352:9: E123: closing bracket does not match indentation of opening bracket's line
lib/ansible/plugins/filter/core.py:361:5: E303: too many blank lines (2)
lib/ansible/plugins/filter/core.py:361:15: E225: missing whitespace around operator
lib/ansible/plugins/filter/core.py:361:25: E226: missing whitespace around arithmetic operator
lib/ansible/plugins/filter/core.py:370:13: E201: whitespace after '{'
lib/ansible/plugins/filter/core.py:370:57: E202: whitespace before '}'
lib/ansible/plugins/filter/core.py:372:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:11:48: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:11:61: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:78:24: E225: missing whitespace around operator
test/units/plugins/filter/test_core.py:79:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:80:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:85:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:86:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:91:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:92:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:97:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:98:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:103:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:104:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:109:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:110:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:115:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:116:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:121:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:122:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:127:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:128:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:133:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:134:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:139:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:140:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:145:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:146:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:151:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:152:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:157:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:158:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:163:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:164:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:169:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:170:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:175:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:176:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:181:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:182:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:187:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:188:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:193:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:194:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:199:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:200:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:205:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:206:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:211:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:212:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:217:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:218:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:223:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:224:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:229:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:230:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:235:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:236:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:241:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:242:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:247:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:248:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:253:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:254:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:259:6: E201: whitespace after '('
test/units/plugins/filter/test_core.py:260:10: E201: whitespace after '{'
test/units/plugins/filter/test_core.py:265:9: E126: continuation line over-indented for hanging indent
test/units/plugins/filter/test_core.py:267:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:317:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:323:1: E305: expected 2 blank lines after class or function definition, found 1
test/units/plugins/filter/test_core.py:323:29: E225: missing whitespace around operator
test/units/plugins/filter/test_core.py:328:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:334:1: E305: expected 2 blank lines after class or function definition, found 1
test/units/plugins/filter/test_core.py:334:20: E225: missing whitespace around operator
test/units/plugins/filter/test_core.py:340:1: E302: expected 2 blank lines, found 1
test/units/plugins/filter/test_core.py:345:9: E123: closing bracket does not match indentation of opening bracket's line
test/units/plugins/filter/test_core.py:347:56: E231: missing whitespace after ','
test/units/plugins/filter/test_core.py:349:29: E231: missing whitespace after ','

The test ansible-test sanity --test compile --python 2.6 [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:370:46: SyntaxError: return { k: semver.__getattribute__(k) for k in keys }

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/plugins/filter/core.py:349:0: dangerous-default-value: Dangerous default value SEMVER_VALID_KEYS (builtins.list) as argument

click here for bot help

Fix is described here https://satran.in/b/python--dangerous-default-value-as-argument

Source: https://stackoverflow.com/questions/4514162/collecting-key-value-pairs-in-python-2-6

JensHeinrich · 2023-06-21T06:22:54Z

as mentioned by matt, no need to do the filtering
done

docs should now live in it's own yaml file document adjacent docs (sidecar) #79056
done

version_added should be the 'core' version, 2.15 at this point
done

JensHeinrich mentioned this pull request Mar 17, 2021

Add a Semver filter ansible-collections/community.general#2033

Closed

1 task

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Mar 17, 2021

ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 18, 2021

ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Mar 18, 2021

ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 18, 2021

Add error handling

5bbce2f

ansibot removed the needs_info This issue requires further information. Please answer any outstanding questions. label Jun 21, 2023

Jens Heinrich added 17 commits June 21, 2023 07:00

Add initial tests for parse_semver filter

37f7fea

Add type check

5f93ed5

Fix tests

8c03391

Fix pep8 formatting

47b0cc1

Replace dangerous default value

7804145

Fix is described here https://satran.in/b/python--dangerous-default-value-as-argument

Remove trailing new line

e931a3b

Add space around operator

3e2a79d

Fix pep8

d3c47de

Fix pep8 missing blank lines

7791cd7

Change return

3449ed8

Move semver keys to frozenset

31fbc79

Add documentation

9cec643

Add explicit version examples

9d735e7

Move return of the filter to comments

365d2ee

Add python2.6 compatible syntax

37b7292

Source: https://stackoverflow.com/questions/4514162/collecting-key-value-pairs-in-python-2-6

Add author

c709591

Remove filtering.

4f355d5

JensHeinrich force-pushed the feature/semver-as-filter branch from a7178e5 to 4f355d5 Compare June 21, 2023 06:20

JensHeinrich requested a review from bcoca June 21, 2023 06:31

Remove keys parameter

7c5b41a

ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Jun 29, 2023

ansibot added stale_review Updates were made after the last review and the last review is more than 7 days old. and removed has_issue labels Jul 12, 2023

Add a parse_semver filter #73935

Add a parse_semver filter #73935

JensHeinrich commented Mar 17, 2021

ansibot commented Mar 17, 2021

bmillemathias commented Mar 18, 2021

JensHeinrich commented Mar 18, 2021

ansibot commented Mar 18, 2021

bmillemathias commented Mar 18, 2021

ansibot commented Mar 18, 2021

ansibot commented Mar 18, 2021

JensHeinrich commented Jun 21, 2023

Add a parse_semver filter #73935

Are you sure you want to change the base?

Add a parse_semver filter #73935

Conversation

JensHeinrich commented Mar 17, 2021

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibot commented Mar 17, 2021

bmillemathias commented Mar 18, 2021

JensHeinrich commented Mar 18, 2021

ansibot commented Mar 18, 2021

bmillemathias commented Mar 18, 2021

ansibot commented Mar 18, 2021

ansibot commented Mar 18, 2021

JensHeinrich commented Jun 21, 2023