csurfer / blackcellmagic Goto Github PK

View Code? Open in Web Editor NEW

306.0 12.0 13.0 40 KB

IPython magic command to format python code in cell using black.

License: MIT License

Python 100.00%

blackcellmagic's Introduction

blackcellmagic

IPython magic command to format python code in cell using black.

What is the magic command?

%%black

Setup

Using pip

pip install blackcellmagic

Directly from the repository

git clone https://github.com/csurfer/blackcellmagic.git
python blackcellmagic/setup.py install

Load Extension in IPython

%load_ext blackcellmagic

Usage

# To have it formatted to black default length 88 with string normalization.
%%black

# To have it formatted to a particular line length.
%%black -l 79
%%black --line-length 79

# To skip string normalization.
%%black -S
%%black --skip-string-normalization

Extras

Tobin Jones has been kind enough to develop a NPM package over blackcellmagic to format all cells at once which can be found here.

Contributing

Bug Reports and Feature Requests

Please use issue tracker for reporting bugs or feature requests.

Development

Pull requests are most welcome.

Buy the developer a cup of coffee!

If you found the utility helpful you can buy me a cup of coffee using

blackcellmagic's People

Contributors

Stargazers

Watchers

Forkers

guanlongtianzi neffmallon priya-gittest lamourj rcmike123 agpeshal christylaflamme raybellwaves sadatian python-repository-hub tvetterli-fn jayant91089 iq-scm

blackcellmagic's Issues

Feature Request: Auto Reformat on Execute & Save

Hello!

I would love if

my cell was automatically formatted on save
automatically format all cells on save (hopefully this isn't slow, but I guess a dirty flag could be set?)

I'm using VS Code. When I'm working on .py files, VS Code automatically does black formatting (and import sorting!) when I save. I wish I had that in my notebooks in VS Code as well. 🥲

If I have time I may dig into how I add that.

Incompatible with black 19.3b0

Running with 19.3b0 gives the following error:

[blah-blah]python3.6/site-packages/blackcellmagic.py in black(self, line, cell)
     39         if cell:
     40             self.shell.set_next_input(
---> 41                 format_str(src_contents=cell, line_length=line_length),
     42                 replace=True,
     43             )

TypeError: format_str() got an unexpected keyword argument 'line_length'

It seems like this is a result of some changes to how format_str works. I believe line_length is determined by mode now.

Downgrading black by pip install black==18.9b0 fixes this issue.

%%black will not format cell with magic in it

When formatting cells with magic in it, like

  [...]
  import matplotlib.pyplot as plt
  import seaborn as sns
  import pandas as pd
  %matplotlib inline

the %%black magic returns the error
cannot parse: 12:0 %matplotlib inline

This happens with any line that has a % sign to indicate magic.

New line at end of cell

It seems a little weird to have a new line at the end of the cell. As far as I understand, the purpose for the new line at the end of the file is for versioning, but in jupyder notebooks, the code of each cell is already contained just a single line. Should the default behavior be to not end each cell with a new line?