python(9)

NAME

py-doc - "Display Python manual page"

SYNOPSIS

python - Python Language File.
py-doc "man-page"

FILES

hkpython.emf - Python Language file hook definition and py-doc macro implementation
python.eaf - Python abbreviation file
python.etf - Python template file

EXTENSIONS

.py - Python file

MAGIC STRINGS

^#![ \t]*/.*env[ \t]+python


MicroEmacs recognizes the magic string on the first line of the file used to locate the executable. The Python files may be extension-less and are still recognized.

DESCRIPTION

The python file type template provides simple hilighting of Python files, the template provides minimal hilighting.

File recognition is performed using the standard file extension .py, or by the magic string.

It offers as well folding and support for displaying an outline of the functions of the Python script for easy navigation using the item-list(3) command. Further is is possible to expand abbreviations either via short strings using the expand-abbrev-handle(3) command and visual inserting abbreviations using the mouse by the abbrev-list(3) macro.

Folding and Information Hiding


Generic folding is enabled within the Python files. The folds occur about the def or class keywords located on the left-hand margin at the beginning of the line. The following commands are supported to show and hide the function bodies. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

List Items


Item listing is available and the key constructs of the file may be listed in the item-list.

Abbreviations


The installation comes with a default abbreviation file for Python code editing which can be used by writing short abbreviations like "main" for a default Python application outline,"for", "if" or "def" - for a Python function, "class" for a Python class - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Short Cuts


The short cut keys used within the buffer are:-

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with stars (*).
A-C-i - Restyle the current region.
f2 - (un)fold the current region
f3 - (un)fold all regions
f6 - list items
esc f6 - close list items

Executing, Formatting and Linting Python Code


The Python file hook supports the file-exec(3), the file-format(3) and the file-lint(3) macros. The tools which are currently supported are Python 3 and 2 interpreters, the formatters ruff, yapf and black and linters ruff and pylint. All of these tools can usually be installed using the default package manager of your system or using the pip3 package manager of Python. Here an example on how to install the Python linter and formatter ruff using the pip package manager:

pip3 install ruff --user 

py-doc macro


py-doc provides a mechanism to display a Python manual page within MicroEmacs. On invoking py-doc the user is prompted for the name of the manual page to display:-

Python help on ? 

The command invokes Python(1) using the pydoc module to generate the requested manual page in a "*py-doc*" buffer. This buffer supports item-list(3) to help browse the content generated.

NOTES

The hilightings or the item-list matches are typically extended using a file mypython.emf.

BUGS

There would appear to be too much applied hilighting in this file, it could probably do with rationalizing.

SEE ALSO

abbrev-list(3), collapse-all(3), collapse-current(3), expand-abbrev-handle(3), file-exec(3), file-format(3), file-lint(3), item-list(3).

Supported File Types

(c) Copyright JASSPA 2025
Last Modified: 2025/08/28
Generated On: 2025/09/29