Code Monkey home page Code Monkey logo

pydev.formatter's Introduction

PyDev Formatter

Features

This package provides a command line API to use the PyDev Code Formatter (the PyDev Code formatter is created by extracting the engine for code formatting provided by PyDev: http://www.pydev.org).

The PyDev Formatter is a conservative python code formatter and will try to keep the structure of the code as close as possible to the original sources, while fixing many common issues such as:

  • Keep a space after commas
  • Trim spaces inside parenthesis
  • Right-trim lines
  • Add a space before and after operators
  • Keep 2 lines before top level classes/methods
  • Keep 1 line before inner classes/methods
  • Add new line at end of file
  • Format comments to have 2 spaces before a comment and 1 space inside the comment

Note that it does not try to break statements to fit any pre-specified line length (as gofmt).

Command line

Basic use of the formatter is:

python -m pydevf <filename_or_directory>

python -m pydevf -h may be used to see the help for additional parameters.

Installing

Requisites

  • java 8+ (so, make sure java is installed and in your PATH)
  • python 2.7 or 3.4 onwards
  • click 6+

Install with pip

To install the PyDev Formatter use:

pip install pydevf

Using with pre-commit

To use it with pre-commit, just add the following repo to your .pre-commit-config.yaml:

-   repo: https://github.com/fabioz/PyDev.Formatter
    rev: ''  # Use the sha or tag you want to point at
    hooks:
    -   id: pydevf

Dealing with big lines

Note that in PyDev there are tools to help on those manual cases. i.e.:

Wrap docstrings/comments with Ctrl+2, W -- See: http://pydev.blogspot.com/2015/04/wrapping-docstringscomments-in-pydev.html.

Wrap/unwrap lists/calls with Ctrl+1, Wrap expression/Unwrap expression (used with cursor inside the list/call).

Daemon mode

By default the formatter will create a daemon and will reuse it among multiple invocations (because the formatter is very fast but its startup is slow). If you don't want to use this mode use the --no-daemon parameter.

License

  • EPL (Eclipse Public License) 2.0

Releasing

  • Update versions on setup.py and version.py
  • git tag {{version}} (i.e.: v0.1.2)
  • git push --tags (travis should build and deploy)

Local release

  • Update versions on setup.py and version.py
  • python setup.py sdist bdist_wheel
  • python -m twine upload dist/*

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.