A tool that ensures consistent string quotes in your Python code.

Last update: Sep 13, 2022

Overview

pyquotes

Single quotes are superior. And if you disagree, there's an option for this as well.

In any case, quotes should be consistent throughout the codebase, and not rely on tools like black that reformat everything. Of course using those tools is perfectly fine if you want this behavior, but sometimes you just want to avoid discussing the quote style during PR reviews).

Installation

Install pyquotes using pip:

$ pip install pyquotes

Usage

$ pyquotes --help
Usage: pyquotes [OPTIONS] FILES...

  A tool that ensures consistent string quotes in your Python code.

  When passing a directory, all *.py files inside will be processed
  recursively.

  If any files needed changes, it exits with a non-zero status code.

Options:
  -V, --version                 Show the version and exit.
  -h, --help                    Show this message and exit.
  -D, --double-quotes           Prefer double quotes.
  -q, --quiet                   Do not output which files have been
                                reformatted.

  -v, --verbose                 Be more verbose and show all files being
                                processed.

  -d, --diff                    Only show diffs without updating files.
  -c, --check-only, --check     Only check files without updating them.
  --exclude PATTERN             Exclude files/directories matching this
                                pattern. Can be used multiple times. Replaces
                                the built-in excludes. Does not apply to
                                explicitly-specified files.

  -X, --extend-exclude PATTERN  Exclude files/directories matching this
                                pattern. Can be used multiple times. Extends
                                the built-in excludes. Does not apply to
                                explicitly-specified files.

Use --diff or --check-only if you want to run this script in CI (usually using flake8-quotes as explained below is the better choice though).

Configuration

exclude, extend-exclude and double-quotes can be configured via the following files (looked up in this order, the first one containing settings is used):

.pyquotes.cfg - ConfigParser format, settings or pyquotes section
setup.cfg - ConfigParser format, pyquotes or tool:pyquotes section
pyproject.toml - TOML format, tool.pyquotes section

Parsing pyproject.toml requires toml to be installed; a warning is emitted if the file exists and no config is found elsewhere and toml is missing.

Note that exclude should not be used in most cases; unless you really need to whitelist something that's excluded by default.

setup.cfg

[pyquotes]
double-quotes = false
extend-exclude =
    htmlcov
    .vscode

The same format can be used in .pyquotes.cfg as well.

pyproject.toml

[tool.pyquotes]
double-quotes = false
extend-exclude = ['htmlcov', '.vscode']

flake8

If you use flake8, you may want to install flake8-quotes to also get warnings if the code currently has incorrect quotes. You can use the following options if you want single quotes:

[flake8]
inline-quotes = single
multiline-quotes = single
docstring-quotes = double
avoid-escape = true

Note that flake8-quotes is completely independent from this tool, so inconsistencies are possible. Please open an issue if you discover any such cases.

You can share your Chegg account for answers using this bot with your friends without getting your account blocked/flagged

Chegg-Answer-Bot You can share your Chegg account for answers using this bot with your friends without getting your account blocked/flagged Reuirement

27 Dec 24, 2022

Instagram Story View Bot Unencrypted Story Views is a helpful tool that allows thousands of people to watch your posts. It is completely free, source is visible for anyone to modify Type your username, wait for the bot to Automate the Task.

Ιnstagram Story Viewer Bot Usage I made this script under 10 minutes, the idea is to get Unlimited Story Views by Looping the "Submit Button" Update x

4 Oct 28, 2021

We’re releasing an open-source tool you can use now, which we developed as a homemade Just-In-Time database access control tool for our sensitive database. This tool syncs with our directory service, slack, SIEM, and finally, our Apache Cassandra database.

Cassandra Access Control By Aner Izraeli - Intezer Security Manager ([email protected]) We’re releasing an open-source tool you can use now, which

6 Mar 31, 2022

A GitHub Action that automatically reports your Advent of Code progress in a table in your README

Advent README Stars This action adds and maintains a stars report in your README based on your Advent of Code progress. Example Table 2021 Results Day

36 Dec 30, 2022

A self-bot for discord, written in Python, which will send you notifications to your desktop if it detects an intruder on your discord server

1 Jan 11, 2022

A simple python script to send files into your telegram Bot form your PC, Server etc.

telegramSend A simple python script to send files into your telegram Bot form your PC, Server etc. How to Use Install requirements.txt pip3 install -r

1 Jul 19, 2022

Python Tool To Get The Date That Your Account Joined Instagram

Date-Joined-Insta Python Tool To Get The Date That Your Account Joined Instagram You Dont Need To Login Just Enter The UserName If Id Did Not Work Ins

1 Dec 21, 2021

Notion4ever - Python tool for export all your content of Notion page using official Notion API

NOTION4EVER Notion4ever is a small python tool that allows you to free your cont

50 Dec 30, 2022

A powerful bot to copy your google drive data to your team drive

⚛️ Clonebot - Heroku version ⚡ CloneBot is a telegram bot that allows you to copy folder/team drive to team drives. One of the main advantage of this

269 Dec 23, 2022

Comments

Resolves #3 and #5
#3 Added a minimum version of click

#5 Force UTF-8 encoding on reading/writing

I have not bumped version, and will leave that to you pending acceptance of these changes.

Thank you.
opened by ghost 6
Encoding issue
OS: Windows 10 21H2 Python: Python 3.10.4

Steps:

pip install pyquotes

example.py (file is saved as UTF-8 with/without a BOM)

print('こんにちは世界')

pyquotes example.py

return codecs.charmap_decode(input,self.errors,decoding_table)[0] UnicodeDecodeError: 'charmap' codec can't decode byte 0x81 in position 11: character maps to <undefined>

If read_text() and write_text() are replaced with read_bytes() and write_bytes() equivalents, the quote processing is fixed (not tested on Linux). Although, additional new lines are erroneously added, I haven't had a chance to look into why.

Thank you for your time, this library has saved my many hours.
opened by ghost 8
Parsing error
OS: Windows 10 21H2 Python: Python 3.10.4

Steps:

pip install pyquotes

example.py

''' Example File ''' A = "This is a test string." B = 'This is a test string.' C = "This isn't a test string, or is it?" D = f"{A}{B}{C}" E = f'{A}{B}{C}'

pyquotes example.py

pyquotes --check example.py

pyquotes -D example.py

pyquotes -D --check example.py

All fail with the error

File "C:\Python310\lib\site-packages\parso\python\tree.py", line 86, in get_doc_node c = simple_stmt.parent.children AttributeError: 'NoneType' object has no attribute 'children'

If a print('Hello, World!') is added to the file, it behaves as expected.

Thank you for your time, this library has saved my many hours.
opened by ghost 4
click dependency not bounded
OS: Windows 10 21H2 Python: Python 3.10.4

Steps:

pip install "click<7"

pip install pyquotes

example.py

print("Hello, World!")

pyquotes --check example.py pyquotes -D --check example.py

Both fail with the error

File "C:\Python310\lib\site-packages\pyquotes\settings.py", line 96, in __init__ super().__init__(**settings, project_root=project_root) TypeError: _Config.__init__() got an unexpected keyword argument 'check'

This is resolved when using click>=8.

Thank you for your time, this library has saved my many hours.
opened by ghost 2

Releases(v1.0.0)

v1.0.0(Jun 13, 2021)

Initial release
Source code(tar.gz)
Source code(zip)

Owner

Adrian

GitHub Repository

Most Powerful Chatbot On Telegram Bot

About Hello, I am Lycia [リュキア], An Intelligent ChatBot. If You Are Feeling Lonely, You can Always Come to me and Chat With Me! How To Host The easiest

8 May 26, 2021

Discord bot that displays Jazz Jackrabbit 2 server status, current gamemode as "Playing.." status

JJ2-server-status-discord-bot Discord bot that displays Jazz Jackrabbit 2 server status, current gamemode as "Playing.." status How to setup: 0. Downl

2 Dec 09, 2021

Discord bot for polls and votes including STV. Supports hiding results and is written with Discord.py

VoteBot Discord voting bot capable of standard polls, as found in many other bots; anonymous polls, where votes are hidden and totals are only display

6 Nov 15, 2022

A simple tool which automate commands of discord economy bots

A simple tool which automate commands of discord economy bots. Fully configurable using an intuitive configuration made in YAML

5 Sep 18, 2022

A modular Telegram Python bot running on python3 with a sqlalchemy, redislab, mongo database, telethon, and pyrogram.

Zeldris Robot A modular Telegram Python bot running on python3 with a sqlalchemy, redislab, mongo database, telethon, and pyrogram. How to set up/depl

42 Dec 21, 2022

Telegram bot for downloading covid-19 vaccine certificate

cowin-certificate-bot This is the source code of @cowincertbot, A telegram bot inspired by the whatsapp bot implementation of indian government for co

30 Oct 07, 2022

Cyber Userbot

0 May 26, 2022

This software's intent is to automate all activities related to manage Axie Infinity Scholars. It is specially aimed to mangers with large scholar roasters.

Axie Scholars Utilities This software's intent is to automate all activities related to manage Scholars. It is specially aimed to mangers with large s

153 Nov 16, 2022

A tool that ensures consistent string quotes in your Python code.

Related tags

Overview

pyquotes

Installation

Usage

Configuration

setup.cfg

pyproject.toml

flake8

You might also like...

You can share your Chegg account for answers using this bot with your friends without getting your account blocked/flagged

Instagram Story View Bot Unencrypted Story Views is a helpful tool that allows thousands of people to watch your posts. It is completely free, source is visible for anyone to modify Type your username, wait for the bot to Automate the Task.

We’re releasing an open-source tool you can use now, which we developed as a homemade Just-In-Time database access control tool for our sensitive database. This tool syncs with our directory service, slack, SIEM, and finally, our Apache Cassandra database.

A GitHub Action that automatically reports your Advent of Code progress in a table in your README

A self-bot for discord, written in Python, which will send you notifications to your desktop if it detects an intruder on your discord server

A simple python script to send files into your telegram Bot form your PC, Server etc.

Python Tool To Get The Date That Your Account Joined Instagram

Notion4ever - Python tool for export all your content of Notion page using official Notion API

A powerful bot to copy your google drive data to your team drive

Comments

Resolves #3 and #5

Encoding issue

Parsing error

click dependency not bounded

Releases(v1.0.0)

v1.0.0(Jun 13, 2021)

Owner

Adrian

Most Powerful Chatbot On Telegram Bot

Discord bot that displays Jazz Jackrabbit 2 server status, current gamemode as "Playing.." status

Discord bot for polls and votes including STV. Supports hiding results and is written with Discord.py

A simple tool which automate commands of discord economy bots

A modular Telegram Python bot running on python3 with a sqlalchemy, redislab, mongo database, telethon, and pyrogram.

Telegram bot for downloading covid-19 vaccine certificate

Cyber Userbot

This software's intent is to automate all activities related to manage Axie Infinity Scholars. It is specially aimed to mangers with large scholar roasters.

Wrapper for Between - 비트윈을 위한 파이썬 라이브러리

Basic Python3 request wrapper for the PancakeSwap API

A discord token nuker With loads of options that will screw an account up real bad

A Telegram bot to transcribe audio, video and image into text.

Work with the AWS IP address ranges in native Python.

Discord RPC for Notion written in Python

GBSLocalLauncher - A script to compose ENV file for Local Compose

A telegram bot to forward messages automatically when they arrived.

Apple iTunes In-app purchase verification tool

A Simple Telegram Inline Torrent Search Bot by @infotechIT

Balsam Python client API & SDK

Python: Asynchronous client for the Tailscale API