third-party/pre-commit
1
0
Fork 0
mirror of https://github.com/pre-commit/pre-commit.git synced 2026-04-15 01:51:46 +04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Clarify docstring in shebang reader

Browse source
This commit is contained in:
Chris Kuehl 2016-01-08 16:04:39 -08:00
parent 85817b6f4e
commit f15fcf0e22
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
pre_commit/file_classifier/classifier.py
View file

@ -85,9 +85,10 @@ def _guess_types_from_shebang(path):
def _read_interpreter_from_shebang(path):
"""Read an interpreter from a file's shebang.
The first line of a script is guaranteed to be ASCII, so we read ASCII
until we hit a newline (at which point we check if we read a valid shebang)
or a non-ASCII character (at which point we bail).
The first line of a script which has a valid shebang is guaranteed to be
ASCII, so we read ASCII until we hit a newline (at which point we check if
we read a valid shebang) or a non-ASCII character (at which point we bail,
because this can't be a valid script-with-shebang).
:param path: path to text file
:return: interpreter, or None if no shebang could be read