log21 2.8.1b0__tar.gz → 2.9.1__tar.gz

log21-2.9.1/PKG-INFO

@@ -0,0 +1,134 @@
+Metadata-Version: 2.1
+Name: log21
+Version: 2.9.1
+Summary: A simple logging package that helps you log colorized messages in Windows console.
+Author-email: "CodeWriter21(Mehrad Pooryoussof)" <CodeWriter21@gmail.com>
+License: Apache License 2.0
+Project-URL: Homepage, https://github.com/MPCodeWriter21/log21
+Project-URL: Donations, https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md
+Project-URL: Source, https://github.com/MPCodeWriter21/log21
+Keywords: python,log,colorize,color,logging,Python3,CodeWriter21
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS :: MacOS X
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: webcolors
+Requires-Dist: docstring-parser
+Provides-Extra: dev
+Requires-Dist: yapf; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: docformatter; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: json5; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+
+log21
+=====
+
+![version](https://img.shields.io/pypi/v/log21)
+![stars](https://img.shields.io/github/stars/MPCodeWriter21/log21)
+![forks](https://img.shields.io/github/forks/MPCodeWriter21/log21)
+![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
+[![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
+
+A simple logging package that helps you log colorized messages in Windows console and other operating systems.
+
+Features
+--------
+
++ Colors : The main reason for this package was to log text in the Windows console with the support of ANSI colors.
++ Argument parsing : log21's argument parser can be used like python's argparse but it also colorizes the output.
++ Logging : A similar logger to logging. Logger but with colorized output and other options such as levelname
+  modifications. It can also decolorize the output if you want to log into a file.
++ Pretty printing : Have you ever wanted to colorize the output of the pprint module? log21's pretty printer can do
+  that.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will print it in a tree-like
+  structure. It's also colorized XD.
++ ProgressBar : log21's progress bar can be used to show progress of a process in a beautiful way.
++ LoggingWindow : Helps you to log messages and debug your code in a window other than the console.
++ CrashReporter : log21's crash reporter can be used to report crashes in different
+  ways. You can use it to log crashes to console or files or use it to receive crash
+  reports of your program through email. And you can also define your own crash
+  reporter functions and use them instead!
++ Argumentify : You can use the argumentify feature to decrease the number of lines you
+  need to write to parse command-line arguments. It's colored by the way!
++ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues) or submit a pull request.
+
+![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
+![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
+
+Installation
+------------
+
+Well, this is a python package so the first thing you need is python.
+
+If you don't have python installed, please visit [Python.org](https://python.org) and install the latest version of
+python.
+
+Then you can install log21 using pip module:
+
+```bash
+python -m pip install log21 -U
+```
+
+Or you can clone [the repository](https://github.com/MPCodeWriter21/log21) and run:
+
+```bash
+pip install .
+```
+
+Or let the pip get it using git:
+```bash
+pip install git+https://github.com/MPCodeWriter21/log21
+```
+
+Changes
+-------
+
+### 2.9.1
+
++ Update `README.md`.
+
+[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
+
+
+Usage Examples:
+---------------
+
+See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
+
+
+About
+-----
+Author: CodeWriter21 (Mehrad Pooryoussof)
+
+GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
+
+Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
+
+### License
+
+![License](https://img.shields.io/github/license/MPCodeWriter21/log21)
+
+[apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+### Donate
+
+In order to support this project you can donate some crypto of your choice 8D
+
+[Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
+
+Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on GitHub :)
+
+References
+----------
+
++ ANSI Color Codes (
+  Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

log21-2.9.1/README.md

@@ -0,0 +1,103 @@
+log21
+=====
+
+![version](https://img.shields.io/pypi/v/log21)
+![stars](https://img.shields.io/github/stars/MPCodeWriter21/log21)
+![forks](https://img.shields.io/github/forks/MPCodeWriter21/log21)
+![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
+[![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
+
+A simple logging package that helps you log colorized messages in Windows console and other operating systems.
+
+Features
+--------
+
++ Colors : The main reason for this package was to log text in the Windows console with the support of ANSI colors.
++ Argument parsing : log21's argument parser can be used like python's argparse but it also colorizes the output.
++ Logging : A similar logger to logging. Logger but with colorized output and other options such as levelname
+  modifications. It can also decolorize the output if you want to log into a file.
++ Pretty printing : Have you ever wanted to colorize the output of the pprint module? log21's pretty printer can do
+  that.
++ Tree printing : You can pass a dict or list to `log21.tree_print` function and it will print it in a tree-like
+  structure. It's also colorized XD.
++ ProgressBar : log21's progress bar can be used to show progress of a process in a beautiful way.
++ LoggingWindow : Helps you to log messages and debug your code in a window other than the console.
++ CrashReporter : log21's crash reporter can be used to report crashes in different
+  ways. You can use it to log crashes to console or files or use it to receive crash
+  reports of your program through email. And you can also define your own crash
+  reporter functions and use them instead!
++ Argumentify : You can use the argumentify feature to decrease the number of lines you
+  need to write to parse command-line arguments. It's colored by the way!
++ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues) or submit a pull request.
+
+![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
+![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)
+
+Installation
+------------
+
+Well, this is a python package so the first thing you need is python.
+
+If you don't have python installed, please visit [Python.org](https://python.org) and install the latest version of
+python.
+
+Then you can install log21 using pip module:
+
+```bash
+python -m pip install log21 -U
+```
+
+Or you can clone [the repository](https://github.com/MPCodeWriter21/log21) and run:
+
+```bash
+pip install .
+```
+
+Or let the pip get it using git:
+```bash
+pip install git+https://github.com/MPCodeWriter21/log21
+```
+
+Changes
+-------
+
+### 2.9.1
+
++ Update `README.md`.
+
+[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
+
+
+Usage Examples:
+---------------
+
+See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
+
+
+About
+-----
+Author: CodeWriter21 (Mehrad Pooryoussof)
+
+GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
+
+Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
+
+### License
+
+![License](https://img.shields.io/github/license/MPCodeWriter21/log21)
+
+[apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+### Donate
+
+In order to support this project you can donate some crypto of your choice 8D
+
+[Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
+
+Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on GitHub :)
+
+References
+----------
+
++ ANSI Color Codes (
+  Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)

{log21-2.8.1b0 → log21-2.9.1}/pyproject.toml

@@ -26,7 +26,7 @@ dependencies = [
   "webcolors",
   "docstring-parser"
 ]
-version = "2.8.1b0"
+version = "2.9.1"
 
 [tool.setuptools.packages.find]
 where = ["src"]
@@ -62,4 +62,10 @@ dedent_closing_brackets = true
 [tool.isort]
 line_length = 88
 combine_as_imports = true
+length_sort = true
 order_by_type = true
+
+[tool.docformatter]
+recursive = true
+wrap-summaries = 88
+wrap-descriptions = 88

{log21-2.8.1b0 → log21-2.9.1}/src/log21/Logger.py

@@ -2,9 +2,10 @@
 # CodeWriter21
 
 import re as _re
+import sys as _sys
 import logging as _logging
 from types import MethodType as _MethodType
-from typing import (Union as _Union, Literal as _Literal, Mapping,
+from typing import (Any, List, Union as _Union, Literal as _Literal, Mapping,
                     Callable as _Callable, Optional as _Optional, Sequence as _Sequence)
 from getpass import getpass as _getpass
 from logging import raiseExceptions as _raiseExceptions
@@ -40,7 +41,7 @@ class Logger(_logging.Logger):
                     handlers = [handlers]
                 else:
                     raise TypeError(
-                        "handlers must be a list of logging.Handler objects"
+                        'handlers must be a list of logging.Handler objects'
                     )
             for handler in handlers:
                 self.addHandler(handler)
@@ -61,7 +62,7 @@ class Logger(_logging.Logger):
         msg = ' '.join([str(m) for m in msg]) + end
         if not isinstance(level, int):
             if _raiseExceptions:
-                raise TypeError("level must be an integer")
+                raise TypeError('level must be an integer')
             return
         if self.isEnabledFor(level):
             self._log(level, msg, args, **kwargs)
@@ -161,8 +162,9 @@ class Logger(_logging.Logger):
         """Log 'msg % args'.
 
         To pass exception information, use the keyword argument exc_info with a true
-        value, e.g.
+        value.
 
+        Usage example:
         age = logger.input("Enter your age: ")
         """
         msg = ' '.join([str(m) for m in msg]) + end
@@ -170,10 +172,12 @@ class Logger(_logging.Logger):
         return input()
 
     def getpass(self, *msg, args: tuple = (), end='', **kwargs):
-        """
-
+        """Takes a password input from the user.
 
-        :return:
+        :param msg: The message to display to the user.
+        :param args: The arguments to pass to the message.
+        :param end: The ending character to append to the message.
+        :return: The password.
         """
         msg = ' '.join([str(m) for m in msg]) + end
         self._log(self.level if self.level >= NOTSET else NOTSET, msg, args, **kwargs)
@@ -213,7 +217,7 @@ class Logger(_logging.Logger):
         self,
         level: int,
         name: str,
-        errors: _Literal["raise", "ignore", "handle", "force"] = "raise"
+        errors: _Literal['raise', 'ignore', 'handle', 'force'] = 'raise'
     ) -> str:
         """Adds a new method to the logger with a specific level and name.
 
@@ -276,7 +280,7 @@ class Logger(_logging.Logger):
     def add_levels(
         self,
         level_names: Mapping[int, str],
-        errors: _Literal["raise", "ignore", "handle", "force"] = "raise"
+        errors: _Literal['raise', 'ignore', 'handle', 'force'] = 'raise'
     ) -> None:
         """Adds new methods to the logger with specific levels and names.
 
@@ -287,6 +291,108 @@ class Logger(_logging.Logger):
         for level, name in level_names.items():
             self.add_level(level, name, errors)
 
+    def __lshift__(self, obj):
+        """Prints the object to the output stream.
+        This operator is meant to make the Logger object be usable in a
+        std::cout-like way.
+
+        :param obj: The object to print.
+        :return: The Logger object.
+        """
+        logger = self
+        found = 0
+        while logger:
+            for handler in logger.handlers:
+                if (isinstance(handler, _logging.StreamHandler)
+                        and hasattr(handler.stream, 'write')
+                        and hasattr(handler.stream, 'flush')):
+                    found = found + 1
+                    handler.stream.write(str(obj))
+                    handler.stream.flush()
+            if not logger.propagate:
+                break
+            logger = logger.parent
+        if found == 0:
+            _sys.stderr.write(
+                f"No handlers could be found for logger \"{self.name}\"\n"
+            )
+        return self
+
+    def __rshift__(self, obj: List[Any]):
+        """A way of receiving input from the stdin.
+        This operator is meant to make a std::cin-like operation possible in Python.
+
+        Usage examples:
+        >>> import log21
+        >>> cout = cin = log21.get_logger()
+        >>>
+        >>> # Example 1
+        >>> # Get three inputs of type: str, str or None, and float
+        >>> data = [str, None, float]  # first name, last name and age
+        >>> cout << "Please enter a first name, last name and age(separated by space): "
+        Please enter a first name, last name and age(separated by space): 
+        >>> cin >> data;
+        M  21
+        >>> name = data[0] + (data[1] if data[1] is not None else '')
+        >>> age = data[2]
+        >>> cout << name << " is " << age << " years old." << log21.endl;
+        M is 21.0 years old.
+        >>>
+        >>> # Example 2
+        >>> # Get any number of inputs
+        >>> data = []
+        >>> cout << "Enter something: ";
+        Enter something: 
+        >>> cin >> data;
+        What ever man 1 2 3 !
+        >>> cout << "Here are the items you chose: " << data << log21.endl;
+        Here are the items you chose: ['What', 'ever', 'man', '1', '2', '3', '!']
+        >>>
+        >>> # Example 3
+        >>> # Get two inputs of type int with defaults: 1280 and 720
+        >>> data = [1280, 720]
+        >>> cout << "Enter the width and the height: ";
+        Enter the width and the height: 
+        >>> cin >> data;
+        500
+
+        >>> cout << "Width: " << data[0] << " Height: " << data[1] << log21.endl;
+        Width: 500 Height: 720
+        >>>
+
+        :param obj: The object to redirect the output to.
+        :return: The Logger object.
+        """
+        n = len(obj) - 1
+        if n >= 0:
+            data = []
+            while n >= 0:
+                tmp = _sys.stdin.readline()[:-1].split(' ', maxsplit=n)
+                if tmp:
+                    data.extend(tmp)
+                else:
+                    data.append('')
+                n -= len(tmp)
+            tmp = []
+            for i, item in enumerate(data):
+                if obj[i] is None:
+                    tmp.append(item or None)
+                elif isinstance(obj[i], type):
+                    try:
+                        tmp.append(obj[i](item))
+                    except ValueError:
+                        tmp.append(obj[i]())
+                else:
+                    try:
+                        tmp.append(obj[i].__class__(item))
+                    except ValueError:
+                        tmp.append(obj[i])
+            obj[:] = tmp
+        else:
+            obj[:] = _sys.stdin.readline()[:-1].split()
+
+        return self
+
 
 def _add_one(name: str) -> str:
     """Add one to the end of a string.

{log21-2.8.1b0 → log21-2.9.1}/src/log21/__init__.py

@@ -6,35 +6,34 @@ import logging as _logging
 from typing import (Type as _Type, Tuple as _Tuple, Union as _Union,
                     Mapping as _Mapping, Optional as _Optional)
 
-from log21 import CrashReporter
-from log21.Colors import (Colors, get_color, get_colors, ansi_escape, closest_color,
-                          get_color_name)
-from log21.Levels import (INFO, WARN, DEBUG, ERROR, FATAL, INPUT, NOTSET, WARNING,
-                          CRITICAL)
-from log21.Logger import Logger
-from log21.PPrint import PrettyPrinter, pformat
-from log21.Manager import Manager
-from log21.Argparse import ColorizingArgumentParser
-from log21.TreePrint import TreePrint, tree_format
-from log21.Formatters import ColorizingFormatter, DecolorizingFormatter, _Formatter
-from log21.Argumentify import argumentify
-from log21.FileHandler import FileHandler, DecolorizingFileHandler
-from log21.ProgressBar import ProgressBar
-from log21.LoggingWindow import LoggingWindow, LoggingWindowHandler
-from log21.StreamHandler import StreamHandler, ColorizingStreamHandler
-
-__version__ = "2.8.1b0"
-__author__ = "CodeWriter21 (Mehrad Pooryoussof)"
-__github__ = "Https://GitHub.com/MPCodeWriter21/log21"
+from . import CrashReporter
+from .Colors import (Colors, get_color, get_colors, ansi_escape, closest_color,
+                     get_color_name)
+from .Levels import INFO, WARN, DEBUG, ERROR, FATAL, INPUT, NOTSET, WARNING, CRITICAL
+from .Logger import Logger
+from .PPrint import PrettyPrinter, pformat
+from .Manager import Manager
+from .Argparse import ColorizingArgumentParser
+from .TreePrint import TreePrint, tree_format
+from .Formatters import ColorizingFormatter, DecolorizingFormatter, _Formatter
+from .Argumentify import argumentify
+from .FileHandler import FileHandler, DecolorizingFileHandler
+from .ProgressBar import ProgressBar
+from .LoggingWindow import LoggingWindow, LoggingWindowHandler
+from .StreamHandler import StreamHandler, ColorizingStreamHandler
+
+__author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
+__version__ = '2.9.1'
+__github__ = 'Https://GitHub.com/MPCodeWriter21/log21'
 __all__ = [
     'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',
     'DecolorizingFormatter', 'get_logger', 'Logger', 'Colors', 'get_color',
     'get_colors', 'CRITICAL', 'FATAL', 'ERROR', 'WARNING', 'WARN', 'INFO', 'DEBUG',
     'NOTSET', 'INPUT', 'StreamHandler', 'ColorizingArgumentParser', 'PrettyPrinter',
     'pformat', 'pprint', 'pretty_print', 'tree_format', 'TreePrint', 'Manager',
-    'get_color_name', 'closest_color', 'ansi_escape', '__version__', '__author__',
-    '__github__', 'debug', 'info', 'warning', 'warn', 'error', 'critical', 'fatal',
-    'exception', 'log', 'basic_config', 'basicConfig', 'ProgressBar', 'progress_bar',
+    'get_color_name', 'closest_color', 'ansi_escape', '__author__', '__github__',
+    'debug', 'info', 'warning', 'warn', 'error', 'critical', 'fatal', 'exception',
+    'log', 'basic_config', 'basicConfig', 'ProgressBar', 'progress_bar',
     'LoggingWindow', 'LoggingWindowHandler', 'get_logging_window', 'CrashReporter',
     'console_reporter', 'file_reporter', 'argumentify'
 ]
@@ -46,7 +45,7 @@ _logging.setLoggerClass(Logger)
 def _prepare_formatter(
     fmt: _Optional[str] = None,
     style: str = '%',
-    datefmt: str = "%H:%M:%S",
+    datefmt: str = '%H:%M:%S',
     show_level: bool = True,
     show_time: bool = True,
     colorize_time_and_level: bool = True,
@@ -57,11 +56,11 @@ def _prepare_formatter(
     # Prepares a formatting if the fmt was None
     if not fmt:
         style = '%'
-        fmt = "%(message)s"
+        fmt = '%(message)s'
         if show_level:
-            fmt = "[%(levelname)s] " + fmt
+            fmt = '[%(levelname)s] ' + fmt
         if show_time:
-            fmt = "[%(asctime)s] " + fmt
+            fmt = '[%(asctime)s] ' + fmt
         fmt = '\r' + fmt
 
     if level_colors and not issubclass(formatter_class, ColorizingFormatter):
@@ -101,7 +100,7 @@ def get_logger(
     show_level: bool = True,
     colorize_time_and_level: bool = True,
     fmt: _Optional[str] = None,
-    datefmt: str = "%H:%M:%S",
+    datefmt: str = '%H:%M:%S',
     style: str = '%',
     handle_carriage_return: bool = True,
     handle_new_line: bool = True,
@@ -209,7 +208,7 @@ def get_logging_window(
     show_level: bool = True,
     colorize_time_and_level: bool = True,
     fmt: _Optional[str] = None,
-    datefmt: str = "%H:%M:%S",
+    datefmt: str = '%H:%M:%S',
     style: str = '%',
     handle_carriage_return: bool = True,
     handle_new_line: bool = True,
@@ -421,7 +420,7 @@ def basic_config(
     stream=None,
     filename=None,
     filemode: str = 'a',
-    date_format: str = "%H:%M:%S",
+    date_format: str = '%H:%M:%S',
     style: str = '%',
     format_: _Optional[str] = None,
     level: _Optional[_Union[int, str]] = None
@@ -627,6 +626,8 @@ def progress_bar(
     print(progress_bar_.get_bar(progress, total))
 
 
+endl = '\n'
+
 console_reporter = CrashReporter.ConsoleReporter()
 
 file_reporter = CrashReporter.FileReporter(file='.crash_report.log')