https://github.com/Mattwmaster58/playwright-python-language-injection

language injection definitions for PyCharm with playwright-python
https://github.com/Mattwmaster58/playwright-python-language-injection

Last synced: 2 months ago
JSON representation

language injection definitions for PyCharm with playwright-python

• Host: GitHub
• URL: https://github.com/Mattwmaster58/playwright-python-language-injection
• Owner: Mattwmaster58
• Created: 2023-05-03T00:29:28.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-05-03T01:13:06.000Z (over 1 year ago)
• Last Synced: 2024-01-24T05:37:24.200Z (12 months ago)
• Language: Python
• Homepage:
• Size: 185 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-playwright - playwright-python-language-injection - Language injection definitions for CSS/JS syntax highlighting when using `python-playwright` in PyCharm. (Utils)

README

        
## playwright-python-language-injection

### Demo

#### Before

![picture of IDE before](./screenshots/before.png)

#### After

![picture of IDE after](./screenshots/after.png)

### What is this?

This repo contains the script to generate [language injection](https://www.jetbrains.com/help/pycharm/using-language-injections.html) definitions for using [playwright-python](https://github.com/microsoft/playwright-python) in PyCharm. From the link:

> Language injections let you work with pieces of code in other languages embedded in your code. When you inject a language (such as HTML, CSS, XML, RegExp, and so on) into a string literal, you get comprehensive code assistance for editing that literal.

## How do I use this?

The script `generate.py` generates a file `playwright-X.xml` where X is the major component of the installed playwright version. Or, you can just download the [last generated version directly](./playwright-1.xml).

After downloading, open up your settings in PyCharm → Editor → Language Injections → Import, and select the file you just downloaded.

![screenshot of settings page](./screenshots/settings.png)

### How does this work?

Since the developers of `playwright-python` were consistent with their style, that made this script a lot easier to write. Every single occurrence of a CSS selector argument in a function uses the name `selector` and every occurrence of a JS expression uses the argument name `expression`. So it's as simple as iterating over the entire API surface, and finding methods that have arguments that match the name and type annotation of `str`. Both async and sync APIs are supported.