style(src): improve the head of all modules

Xiaokang2022 · Xiaokang2022 · commit ea71f6fc7d00 · 2025-09-20T21:49:12.000+08:00
diff --git a/maliang/__init__.py b/maliang/__init__.py
@@ -1,26 +1,7 @@
-# MIT License
+# Copyright (c) 2023-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
 
-# Copyright (c) 2022 Xiaokang2022
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-"""A lightweight UI framework based on `tkinter` with all UI drawn in `Canvas`.
+"""A lightweight UI framework based on ``tkinter`` with all UI drawn in Canvas.
 
 * Website: https://xiaokang2022.github.io/maliang/
 * GitHub: https://github.com/Xiaokang2022/maliang
diff --git a/maliang/animation/__init__.py b/maliang/animation/__init__.py
@@ -1,8 +1,11 @@
-"""A subpackage that provides animation-related features.
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""A subpackage of ``maliang`` that provides animation-related features.
 
 A highly customizable animation base class and related subclasses are provided,
 as well as highly customizable control functions. In addition, control
-functions also applies to the related functions of the `color` subpackage.
+functions also applies to the related functions of the ``color`` subpackage.
 """
 
 from .animations import *
diff --git a/maliang/animation/animations.py b/maliang/animation/animations.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Base and standard animation classes.
 
 The animation base class can be inherited or called directly. Other standard
diff --git a/maliang/animation/controllers.py b/maliang/animation/controllers.py
@@ -1,13 +1,19 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Controller generator and standard control functions.
 
 Definition of control function:
 
-```python
-def f(t: float) -> float: ...
-```
+    def control_function(t: float) -> float:
+        \"""Control function for animation.
+
+        Args:
+            t: the percentage of time
 
-* `t`: 0% ~ 100%, indicates the percentage of time
-* return: real number, indicates a multiple of the cardinality of the animation
+        Returns:
+            a multiple of the cardinality of the animation
+        \"""
 """
 
 from __future__ import annotations as _
diff --git a/maliang/color/__init__.py b/maliang/color/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """A subpackage that provides color-related features.
 
 Supports the processing of color strings in RGB and HSL formats, as well as the
diff --git a/maliang/color/colortable.py b/maliang/color/colortable.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Mapping table between the color names and the RGB codes."""
 
 from __future__ import annotations as _
diff --git a/maliang/color/convert.py b/maliang/color/convert.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Convert a format of color to another format.
 
 * RGB: tuple, (Red, Green, Blue)
diff --git a/maliang/color/hsl.py b/maliang/color/hsl.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Some functions about HSL codes."""
 
 from __future__ import annotations as _
diff --git a/maliang/color/rgb.py b/maliang/color/rgb.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Some functions about RGB codes."""
 
 from __future__ import annotations as _
diff --git a/maliang/core/__init__.py b/maliang/core/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """The core code, you can see the general framework here.
 
 Most of the abstract and base classes are defined here.
diff --git a/maliang/core/configs.py b/maliang/core/configs.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """All global configuration options.
 
 Some options are read-only, but most of them can be changed, and once changed,
diff --git a/maliang/core/containers.py b/maliang/core/containers.py
@@ -1,10 +1,13 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """All containers.
 
-There are two containers at the window level: `Tk` and `Toplevel`. `Tk` is
-generally used for the main window, while `Toplevel` is a pop-up window.
+There are two containers at the window level: ``Tk`` and ``Toplevel``. ``Tk`` is
+generally used for the main window, while ``Toplevel`` is a pop-up window.
 
-There is another container at the canvas level: `Canvas`. `Canvas` is the main
-container carrier.
+There is another container at the canvas level: ``Canvas``. ``Canvas`` is the
+main container carrier.
 """
 
 from __future__ import annotations as _
diff --git a/maliang/core/virtual.py b/maliang/core/virtual.py
@@ -1,15 +1,19 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """All virtual classes.
 
-The `virtual.Widget` consists of five parts, which are `Shape`, `Text`, `Image`,
-`Style` and `Feature`. In addition, they can be nested within each other.
+The ``virtual.Widget`` consists of five parts, which are ``Shape``, ``Text``,
+``Image``, ``Style`` and ``Feature``. In addition, they can be nested within
+each other.
 
-Where `Feature` is the function of widgets, `Style` control the color of the
-widget, and each widget can be bound to up to one `Feature` and one `Style`,
-but in terms of appearance, there is no limit to the number of `Shape`, `Text`,
-and `Image`.
+Where ``Feature`` is the function of widgets, ``Style`` control the color of the
+widget, and each widget can be bound to up to one ``Feature`` and one ``Style``,
+but in terms of appearance, there is no limit to the number of ``Shape``,
+``Text``, and ``Image``.
 
-`Shape`, `Text`, and `Image` are all appearance elements that inherit from
-abstract base class `Elements`.
+``Shape``, ``Text``, and ``Image`` are all appearance elements that inherit from
+abstract base class ``Elements``.
 """
 
 from __future__ import annotations as _
diff --git a/maliang/standard/__init__.py b/maliang/standard/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """All standard things."""
 
 from .dialogs import *
diff --git a/maliang/standard/dialogs.py b/maliang/standard/dialogs.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2023-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """All standard dialog classes"""
 
 from __future__ import annotations as _
diff --git a/maliang/standard/features.py b/maliang/standard/features.py
@@ -1,4 +1,7 @@
-"""All standard `Feature` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Feature`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/standard/images.py b/maliang/standard/images.py
@@ -1,4 +1,7 @@
-"""All standard `Image` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Image`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/standard/shapes.py b/maliang/standard/shapes.py
@@ -1,4 +1,7 @@
-"""All standard `Shape` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Shape`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/standard/styles.py b/maliang/standard/styles.py
@@ -1,4 +1,7 @@
-"""All standard `Style` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Style`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/standard/texts.py b/maliang/standard/texts.py
@@ -1,4 +1,7 @@
-"""All standard `Text` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Text`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/standard/widgets.py b/maliang/standard/widgets.py
@@ -1,4 +1,7 @@
-"""All standard `Widget` classes"""
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
+"""All standard ``Widget`` classes"""
 
 from __future__ import annotations as _
 
diff --git a/maliang/theme/__init__.py b/maliang/theme/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """A subpackage that provides theme-related features.
 
 Listen to the system's theme and respond accordingly, modify the style of the
diff --git a/maliang/theme/manager.py b/maliang/theme/manager.py
@@ -1,9 +1,12 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Support for theme
 
-* darkdetect: https://github.com/albertosottile/darkdetect
-* pywinstyles: https://github.com/Akascape/py-window-styles
-* win32material: https://github.com/littlewhitecloud/win32material
-* hPyT: https://github.com/Zingzy/hPyT
+* ``darkdetect``: https://pypi.org/project/darkdetect/
+* ``pywinstyles``: https://pypi.org/project/pywinstyles/
+* ``win32material``: https://pypi.org/project/win32material/
+* ``hPyT``: https://pypi.org/project/hPyT/
 """
 
 from __future__ import annotations as _
diff --git a/maliang/toolbox/__init__.py b/maliang/toolbox/__init__.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Some practical tools"""
 
 from .enhanced import *
diff --git a/maliang/toolbox/enhanced.py b/maliang/toolbox/enhanced.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Enhanced versions of some tkinter classes and functions."""
 
 from __future__ import annotations as _
diff --git a/maliang/toolbox/utility.py b/maliang/toolbox/utility.py
@@ -1,3 +1,6 @@
+# Copyright (c) 2024-2025 Xiaokang2022. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for details.
+
 """Some useful utility classes or utility functions."""
 
 from __future__ import annotations as _
