Docstrings != Multiline strings

Fri, 28 Feb 2025 00:00:00 +0000

Before python 3.13, docstrings are also not trimmed by default.

Common leading spaces are trimmed from a docstring since 3.13.

But multiline strings are not treated so. Leading spaces are always what-you-see-is-what-you-get.

% nix run nixpkgs#python313
Python 3.13.2 (main, Feb 4 2025, 14:51:09) [GCC 14.2.1 20241116] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> def a():
... """This is a docstring
... Its indent is not the same across lines.
... This line has more indentation.
... """
... pass
...
>>> a.__doc__
'This is a docstring\nIts indent is not the same across lines.\n This line has more indentation.\n'
>>> def a():
... """
... This is a docstring
... Its indent is not the same across lines.
... This line has more indentation.
... """
... pass
...
>>>
>>> a.__doc__
'\nThis is a docstring\nIts indent is not the same across lines.\n This line has more indentation.\n'
>>> B = """
... This is a multiline string
... Its indent is also not the same across lines.
... """
>>>
>>> B
'\n This is a multiline string\n Its indent is also not the same across lines.\n '
>>> B = """\
... This is a multiline string
... Its indent is also not the same across lines.
... """
>>> B
' This is a multiline string\n Its indent is also not the same across lines.\n '
>>> exit

% nix run nixpkgs#python312
Python 3.12.9 (main, Feb 4 2025, 14:38:38) [GCC 14.2.1 20241116] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> def a():
... """
... This is a docstring.
... Its indent balabala
... """
... pass
...
>>> a.__doc__
'\n\tThis is a docstring.\n\t Its indent balabala\n\t'

#python

How to type annotate a Gzipfile in Python?

Sat, 05 Oct 2024 00:00:00 +0000

Pyright complains when I use the following code to process gzip files:

import gzip
import os
import typing


def readfile(f: os.PathLike | typing.TextIO):
	pass

with gzip.open("/path/to/foo.gz", 'r') as input:
 readfile(input)

Diagnostics:

 Argument of type "GzipFile" cannot be assigned to parameter "file" of type "PathLike[Unknown] | TextIO" in func
 tion "readfile"
   Type "GzipFile" is incompatible with type "PathLike[Unknown] | TextIO"
     "GzipFile" is incompatible with protocol "PathLike[Unknown]"
       "__fspath__" is not present
     "GzipFile" is incompatible with "TextIO" [reportArgumentType]

Text File inside

According to the gzip.open() docs:

The filename argument can be an actual filename (a str or bytes object), or an existing file object to read from or write to.

Python on CuSO4_Deposit

Docstrings != Multiline strings

How to type annotate a Gzipfile in Python?

Text File inside