An initial go at Python Support #69

mrkaiser · 2022-06-12T18:52:00Z

This attempts to solve GH-49. It adds python support via behave
only. This is still a WIP. The tests pass but after building with
changes in language-server and vscode, functionality in real world
applications is severely diminished. Go To Definition and Autocomplete
are currently missing.

🤔 What's changed?

There is python support via the behave library

⚡️ What's your motivation?

Fixes #49

🏷️ What kind of change is this?

⚡ New feature (non-breaking change which adds new behaviour)

♻️ Anything particular you want feedback on?

The tests currently pass. Functionality in an editor (testing with vscode) is however extremely broken, providing no go to definition or autocomplete.

📋 Checklist:

I agree to respect and uphold the Cucumber Community Code of Conduct
I've changed the behaviour of the code
- I have added/updated tests to cover my changes.
My change requires a change to the documentation.
- I have updated the documentation accordingly.
Users should know about my change
- I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

This attempts to solve cucumberGH-49. It adds python support via `behave` only. This is still a WIP. The tests pass but after building with changes in `language-server` and `vscode`, functionality in real world applications is severely diminished. Go To Definition and Autocomplete are currently missing.

aslakhellesoy · 2022-06-12T21:49:59Z

CONTRIBUTING.md

@@ -31,14 +32,17 @@ If your contribution is to add support for a new programming language, follow th
 6. Add the name of the new language to the `LanguageName` type
 7. Update `languageByName` in `src/language/language.ts`
 8. Update `src/tree-sitter-node/NodeParserAdapter.ts`
-9. Run tests
+9. Update `test/language/ExpressionBuilder.test.ts` to include the new language if it supports Cucumber Expressions


aslakhellesoy

Excellent work @mrkaiser! I'm impressed how you've managed to navigate the codebase - everything looks very good.

I like to do a manual test within VSCode (as explained here: https://github.com/cucumber/language-service/blob/main/CONTRIBUTING.md#manual-testing)

Do you know of an online repo that would have some behave code (with custom parameter types) I could use as a test subject?

CONTRIBUTING.md

package.json

src/language/pythonLanguage.ts

src/language/types.ts

test/language/testdata/python/.python-version

mrkaiser · 2022-06-12T22:19:36Z

In hindsight, I should've made this a draft.

mrkaiser · 2022-06-14T01:14:04Z

@aslakhellesoy I am currently working on the PR comments. Something has broken the tests. I am going on a much needed vacation. I will pick this back up next week.

I appreciate the understanding.

* Update CONTRIBUTING.md to include snippet information * Fixed package.json * Reordered languages to alphabetical order * Fixed indentation on tree-sitter queries * Cleaned up python includes (.python-version and .mypy in .gitignore)

mrkaiser · 2022-06-24T02:13:08Z

Hi @aslakhellesoy , while working on the updates to the PR and trying to test vscode, I noticed that tree-sitter-python is not installed in either my local language-server node_modules or in vscode. I think this has to do with linking and installing. I tried reading the npm-link documentation. Unfortunately I'm fairly lost with the toolkit, since I'm not a particularly seasoned typescript or javascript developer. Any ideas here? Is it a red herring?

aslakhellesoy

It looks like you have been working with the assumption that Cucumber Expressions (and Parameter Types) are supported by Behave. Unfortunately they are not.

Someone has ported the Cucumber Expressions library to Python, but nobody has yet integrated it into Behave.

Until that happens I think it's best if we assume all Behave step definitions use regular expressions.

I'm sorry I didn't catch this before - it would probably have saved you some time.

test/language/testdata/python/ParameterTypes.py

test/language/testdata/python/StepDefinitions.py

src/language/pythonLanguage.ts

test/language/testdata/python/StepDefinitions.py

src/language/pythonLanguage.ts

CONTRIBUTING.md

aslakhellesoy · 2022-07-05T13:20:22Z

As discussed - here is how Cucumber Expressions for Java decides whether an expression string should be interpreted as CukeExp or RegExp: https://github.com/cucumber/cucumber-expressions/blob/main/java/src/main/java/io/cucumber/cucumberexpressions/ExpressionFactory.java

Removed and Reverted ParameterType support. Added basic checks for regexes to support _some_ level of "cucumber expression" support (i.e only plain text) to get some go to definitions working Added a better blurb.

mrkaiser · 2022-07-08T00:47:21Z

Not sure why there are conflict with package-lock.json

mrkaiser · 2022-07-08T00:48:59Z

@aslakhellesoy As discussed I have migrated to only regexp. In some instances I choose to just return the string. This works well in practice because "plain ol" strings are also always valid Cucumber Expressions. I do basic checks. This allows some level of go to definition functionality. I have tested with my changes in the language-server and the vscode plugin and looks good enough to ship an initial version of Python support.

Thanks

aslakhellesoy · 2022-07-14T14:15:08Z

Hi @mrkaiser,

Thanks for your making your first contribution to Cucumber, and welcome to the Cucumber committers team! You can now push directly to this repo and all other repos under the cucumber organization! 🍾

In return for this generous offer we hope you will:

✅ Continue to use branches and pull requests. When someone on the core team approves a pull request (yours or someone else's), you're welcome to merge it yourself.
💚 Commit to setting a good example by following and upholding our code of conduct in your interactions with other collaborators and users.
💬 Join the community Slack channel to meet the rest of the team and make yourself at home.
ℹ️ Don't feel obliged to help, just do what you can if you have the time and the energy.
🙋 Ask if you need anything. We're looking for feedback about how to make the project more welcoming, so please tell us!

On behalf of the Cucumber core team,
Aslak Hellesøy
Creator of Cucumber

blaisep · 2023-11-01T16:12:41Z

Hi @mrkaiser , I will reach out to you on the cucumber Slack... ping blaise if you have a chance because I didn't find you in the Slack channel.

mrkaiser added 2 commits June 12, 2022 14:32

Merge branch 'main' into feature/python_support

a5474c7

aslakhellesoy reviewed Jun 12, 2022

View reviewed changes

aslakhellesoy suggested changes Jun 12, 2022

View reviewed changes

Merge branch 'main' into feature/python_support

7ba1a53

Updated to satisfy PR

6a2253a

* Update CONTRIBUTING.md to include snippet information * Fixed package.json * Reordered languages to alphabetical order * Fixed indentation on tree-sitter queries * Cleaned up python includes (.python-version and .mypy in .gitignore)

mrkaiser added 2 commits June 23, 2022 22:18

Fixes a typo

1376fff

Merge branch 'main' into feature/python_support

b183fa0

mrkaiser marked this pull request as draft June 30, 2022 23:35

mrkaiser added 3 commits June 30, 2022 19:43

Ran an npm run eslint

d5337fa

Merge branch 'main' into feature/python_support

1f75425

Updated CHANGELOG

c463b80

aslakhellesoy suggested changes Jul 2, 2022

View reviewed changes

aslakhellesoy mentioned this pull request Jul 2, 2022

Add support for Python (Behave) #49

Closed

aslakhellesoy reviewed Jul 2, 2022

View reviewed changes

src/language/pythonLanguage.ts Outdated Show resolved Hide resolved

aslakhellesoy reviewed Jul 2, 2022

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

Removed ParameterTypes support

bb11b71

Removed and Reverted ParameterType support. Added basic checks for regexes to support _some_ level of "cucumber expression" support (i.e only plain text) to get some go to definitions working Added a better blurb.

mrkaiser marked this pull request as ready for review July 8, 2022 00:45

mrkaiser requested a review from aslakhellesoy July 8, 2022 00:46

aslakhellesoy merged commit 88b4aee into cucumber:main Jul 14, 2022

mrkaiser deleted the feature/python_support branch October 4, 2022 01:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

An initial go at Python Support #69

An initial go at Python Support #69

mrkaiser commented Jun 12, 2022 •

edited

Loading

aslakhellesoy Jun 12, 2022

aslakhellesoy left a comment

mrkaiser commented Jun 12, 2022

mrkaiser commented Jun 14, 2022

mrkaiser commented Jun 24, 2022

aslakhellesoy left a comment

aslakhellesoy commented Jul 5, 2022

mrkaiser commented Jul 8, 2022

mrkaiser commented Jul 8, 2022

aslakhellesoy commented Jul 14, 2022

blaisep commented Nov 1, 2023

An initial go at Python Support #69

An initial go at Python Support #69

Conversation

mrkaiser commented Jun 12, 2022 • edited Loading

🤔 What's changed?

⚡️ What's your motivation?

🏷️ What kind of change is this?

♻️ Anything particular you want feedback on?

📋 Checklist:

aslakhellesoy Jun 12, 2022

Choose a reason for hiding this comment

aslakhellesoy left a comment

Choose a reason for hiding this comment

mrkaiser commented Jun 12, 2022

mrkaiser commented Jun 14, 2022

mrkaiser commented Jun 24, 2022

aslakhellesoy left a comment

Choose a reason for hiding this comment

aslakhellesoy commented Jul 5, 2022

mrkaiser commented Jul 8, 2022

mrkaiser commented Jul 8, 2022

aslakhellesoy commented Jul 14, 2022

blaisep commented Nov 1, 2023

mrkaiser commented Jun 12, 2022 •

edited

Loading