ignoring lines with syntax errors

[rgboyes]

Hi, I've got some databricks/IPython code in a file called test.py with some magic commands that's giving me a syntax error

a = 1
%load_ext autoreload # noqa
b = 2

And as you can see I've tried putting the generic noqa line that I thought would ignore the all errors on the line, but its still giving me a syntax error. Am I right in thinking that ruff should ignore that line? Is there another way of getting it to be ignored?

rich@test:~/src uvx ruff check test.py 
test.py:1:1: SyntaxError: Expected a statement
  |
1 | %load_ext autoreload # noqa
  | ^
  |

test.py:1:11: SyntaxError: Simple statements must be separated by newlines or semicolons
  |
1 | %load_ext autoreload # noqa
  |           ^
  |

[MichaReiser]

Syntax errors aren't suppressible because Ruff can't parse the file and, as a result, can't perform any analysis or formatting on top of it.

I suggest to exclude the file in your ruff configuration (this has the same effect).

@dhruvmanila do I remember it correctly that there's currently no option to allow ipython syntax within python files?

[rgboyes]

Thanks for the fast feedback and straightforward answer.

For any others that might have this issue we found we could fix the problem by moving any magic commands to within their own cells (i.e., not mixed with regular python).

[dhruvmanila]

Yes, that's correct. Currently, there's no way to allow magic commands in a Python file.

We do expose a --extension flag but that's different than what's being asked here. This flag only maps the extension, it's as if Ruff can be configured to see test.py as test.ipynb but that means that test.py should be in the Jupyter Notebook format i.e., JSON.

*       --extension <EXTENSION>            List of mappings from file extension to language (one of `python`, `ipynb`, `pyi`). For example, to treat `.ipy` files as IPython notebooks, use `--extension ipy:ipynb`

[JonGretar]

A solution to your problems is to do this programatically. Replace your magic commands with the following according to this solution:

# %% Autoreload setup
from IPython.core.getipython import get_ipython
from IPython.core.interactiveshell import InteractiveShell

ipython: InteractiveShell | None = get_ipython()
if ipython is not None:
    ipython.run_line_magic("load_ext", "autoreload")
    ipython.run_line_magic("autoreload", "2")

# %%

Now your code is valid Python and Ruff should play nice.