[3.12] GH-108202: Document calendar's command-line interface (GH-…

…109020) (#109030) GH-108202: Document ``calendar``'s command-line interface (GH-109020) (cherry picked from commit f0f96a9) Co-authored-by: Adam Turner <[email protected]> Co-authored-by: Hugo van Kemenade <[email protected]>
python · Sep 8, 2023 · ef0dbfb · ef0dbfb
1 parent 19d8226
commit ef0dbfb
Show file tree

Hide file tree

Showing 2 changed files with 144 additions and 1 deletion.
diff --git a/Doc/library/calendar.rst b/Doc/library/calendar.rst
@@ -489,3 +489,146 @@ The :mod:`calendar` module defines the following exceptions:
 
    Module :mod:`time`
       Low-level time related functions.
+
+
+.. _calendar-cli:
+
+Command-Line Usage
+------------------
+
+.. versionadded:: 2.5
+
+The :mod:`calendar` module can be executed as a script from the command line
+to interactively print a calendar.
+
+.. code-block:: shell
+
+   python -m calendar [-h] [-L LOCALE] [-e ENCODING] [-t {text,html}]
+                      [-w WIDTH] [-l LINES] [-s SPACING] [-m MONTHS] [-c CSS]
+                      [year] [month]
+
+
+For example, to print a calendar for the year 2000:
+
+.. code-block:: console
+
+   $ python -m calendar 2000
+                                     2000
+
+         January                   February                   March
+   Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
+                   1  2          1  2  3  4  5  6             1  2  3  4  5
+    3  4  5  6  7  8  9       7  8  9 10 11 12 13       6  7  8  9 10 11 12
+   10 11 12 13 14 15 16      14 15 16 17 18 19 20      13 14 15 16 17 18 19
+   17 18 19 20 21 22 23      21 22 23 24 25 26 27      20 21 22 23 24 25 26
+   24 25 26 27 28 29 30      28 29                     27 28 29 30 31
+   31
+
+          April                      May                       June
+   Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
+                   1  2       1  2  3  4  5  6  7                1  2  3  4
+    3  4  5  6  7  8  9       8  9 10 11 12 13 14       5  6  7  8  9 10 11
+   10 11 12 13 14 15 16      15 16 17 18 19 20 21      12 13 14 15 16 17 18
+   17 18 19 20 21 22 23      22 23 24 25 26 27 28      19 20 21 22 23 24 25
+   24 25 26 27 28 29 30      29 30 31                  26 27 28 29 30
+
+           July                     August                  September
+   Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
+                   1  2          1  2  3  4  5  6                   1  2  3
+    3  4  5  6  7  8  9       7  8  9 10 11 12 13       4  5  6  7  8  9 10
+   10 11 12 13 14 15 16      14 15 16 17 18 19 20      11 12 13 14 15 16 17
+   17 18 19 20 21 22 23      21 22 23 24 25 26 27      18 19 20 21 22 23 24
+   24 25 26 27 28 29 30      28 29 30 31               25 26 27 28 29 30
+   31
+
+         October                   November                  December
+   Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su      Mo Tu We Th Fr Sa Su
+                      1             1  2  3  4  5                   1  2  3
+    2  3  4  5  6  7  8       6  7  8  9 10 11 12       4  5  6  7  8  9 10
+    9 10 11 12 13 14 15      13 14 15 16 17 18 19      11 12 13 14 15 16 17
+   16 17 18 19 20 21 22      20 21 22 23 24 25 26      18 19 20 21 22 23 24
+   23 24 25 26 27 28 29      27 28 29 30               25 26 27 28 29 30 31
+   30 31
+
+
+The following options are accepted:
+
+.. program:: calendar
+
+
+.. option:: --help, -h
+
+   Show the help message and exit.
+
+
+.. option:: --locale LOCALE, -L LOCALE
+
+   The locale to use for month and weekday names.
+   Defaults to English.
+
+
+.. option:: --encoding ENCODING, -e ENCODING
+
+   The encoding to use for output.
+   :option:`--encoding` is required if :option:`--locale` is set.
+
+
+.. option:: --type {text,html}, -t {text,html}
+
+   Print the calendar to the terminal as text,
+   or as an HTML document.
+
+
+.. option:: year
+
+   The year to print the calendar for.
+   Must be a number between 1 and 9999.
+   Defaults to the current year.
+
+
+.. option:: month
+
+   The month of the specified :option:`year` to print the calendar for.
+   Must be a number between 1 and 12,
+   and may only be used in text mode.
+   Defaults to printing a calendar for the full year.
+
+
+*Text-mode options:*
+
+.. option:: --width WIDTH, -w WIDTH
+
+   The width of the date column in terminal columns.
+   The date is printed centred in the column.
+   Any value lower than 2 is ignored.
+   Defaults to 2.
+
+
+.. option:: --lines LINES, -l LINES
+
+   The number of lines for each week in terminal rows.
+   The date is printed top-aligned.
+   Any value lower than 1 is ignored.
+   Defaults to 1.
+
+
+.. option:: --spacing SPACING, -s SPACING
+
+   The space between months in columns.
+   Any value lower than 2 is ignored.
+   Defaults to 6.
+
+
+.. option:: --months MONTHS, -m MONTHS
+
+   The number of months printed per row.
+   Defaults to 3.
+
+
+*HTML-mode options:*
+
+.. option:: --css CSS, -c CSS
+
+   The path of a CSS stylesheet to use for the calendar.
+   This must either be relative to the generated HTML,
+   or an absolute HTTP or ``file:///`` URL.
diff --git a/Lib/calendar.py b/Lib/calendar.py
@@ -723,7 +723,7 @@ def main(args):
     parser.add_argument(
         "-L", "--locale",
         default=None,
-        help="locale to be used from month and weekday names"
+        help="locale to use for month and weekday names"
     )
     parser.add_argument(
         "-e", "--encoding",