pygments-shell-console 0.0.1__tar.gz

pygments_shell_console-0.0.1/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,36 @@
+name: Publish Python 🐍 distributions 📦 to PyPI
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  build-n-publish:
+    runs-on: ubuntu-latest
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pygments-shell-console
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - name: Set up Python 3.8
+        uses: actions/checkout@master
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pygments_shell_console-0.0.1/.gitignore

@@ -0,0 +1,162 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pygments_shell_console-0.0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.3
+Name: pygments-shell-console
+Version: 0.0.1
+Requires-Dist: pygments
+Description-Content-Type: text/markdown
+
+# Pygments Shell Console
+
+This Pygments plugin adds new lexers for shell console output. The lexers are:
+- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
+    extends its behavior to recognize the prompt elements and use `DiffLexer` and `GitLexer` for highlighting.
+- `GitLexer`: Adds support for highlighting git log output, following the format:
+    ```
+    log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
+    ```

pygments_shell_console-0.0.1/README.md

@@ -0,0 +1,9 @@
+# Pygments Shell Console
+
+This Pygments plugin adds new lexers for shell console output. The lexers are:
+- `ShellConsoleLexer`: Based in [`ShellSessionBaseLexer`](https://github.com/pygments/pygments/blob/master/pygments/lexers/shell.py#L151C7-L151C28),
+    extends its behavior to recognize the prompt elements and use `DiffLexer` and `GitLexer` for highlighting.
+- `GitLexer`: Adds support for highlighting git log output, following the format:
+    ```
+    log --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold green)(%ar)%C(reset) %C(white)%s%C(reset) %C(dim white)- %an%C(reset)%C(bold yellow)%d%C(reset)'
+    ```

pygments_shell_console-0.0.1/git_lexer.py

@@ -0,0 +1,82 @@
+"""An example plugin lexer for Pygments."""
+
+from pygments.lexer import Lexer
+from pygments.lexer import RegexLexer, ExtendedRegexLexer, include, bygroups, \
+    default, using, line_re, do_insertions
+from pygments.token import Token, Punctuation, Whitespace, \
+    Text, Comment, Operator, Keyword, Name, String, Number, Generic
+from pygments.lexers.diff import DiffLexer
+from pygments.token import STANDARD_TYPES
+
+import re
+
+__all__ = ['GitLexer']
+
+STANDARD_TYPES.update({
+    Token.Git: 'git',
+    Token.Git.BranchLine: 'git-bl',
+    Token.Git.CommitHash: 'git-ch',
+    Token.Git.CommitDate: 'git-cd',
+    Token.Git.CommitMessage: 'git-cm',
+    Token.Git.CommitAuthor: 'git-ca',
+    Token.Git.Refs: 'git-r',
+})
+
+class GitLexer(Lexer):
+    name = "Git"
+    aliases = ["git"]
+    filenames = ['*.git']
+    version_added = '1.0'
+
+    _branch_line_rgx = r'([\|\\\/ ]*)'
+    _logrgx_groups = [
+      _branch_line_rgx,     # Branch line
+      r'(\*)',          # Commit asterisk
+      _branch_line_rgx,     # Branch line
+      r'( +)',          # Space
+      r'([a-f0-9]+)',   # Commit hash
+      r'( +- +)',       # Commit separator
+      r'(\([0-9A-Za-zÀ-ÖØ-öø-ÿ ]+\))', # Date
+      r'(\s+[0-9A-Za-zÀ-ÖØ-öø-ÿ \.\:\_\'\"\!\?\(\)\\\/\-]+ +- +)', # Commit message
+      r'([0-9A-Za-zÀ-ÖØ-öø-ÿ ]+)', # Author
+      r'((\([\w ->,:]+\))?)', # Refs
+      r'$', # End
+    ]
+
+    # Combine the regex patterns into a single pattern
+    _logrgx = re.compile(r''.join(_logrgx_groups))
+
+    _log_tokens = {
+      1: Token.Git.BranchLine,
+      3: Token.Git.BranchLine,
+      4: Whitespace,
+      5: Token.Git.CommitHash,
+      7: Token.Git.CommitDate,
+      8: Token.Git.CommitMessage,
+      9: Token.Git.CommitAuthor,
+      10: Token.Git.Refs,
+    }
+
+    def get_tokens_unprocessed(self, text):
+        pos = 0
+
+        for match in line_re.finditer(text):
+            line = match.group()
+
+            match_log = self._logrgx.match(line)
+            match_branch_line = re.match(r'^' + self._branch_line_rgx + r'$', line)
+
+            ## Line is log
+            if match_log:
+                for i in range(1, len(match_log.groups())):
+                    if match_log.group(i):
+                        if self._log_tokens.get(i):
+                            yield match_log.start(i), self._log_tokens[i], match_log.group(i)
+                        else:
+                            yield match_log.start(i), Generic.Output, match_log.group(i)
+                yield match.end(), Whitespace, '\n'
+            elif match_branch_line:
+                yield match.start(), Token.Git.BranchLine, line
+
+            else:
+                yield match.start(), Generic.Output, line

pygments_shell_console-0.0.1/pyproject.toml

@@ -0,0 +1,25 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pygments-shell-console" # change this to a package name for your plugin
+version = "0.0.1"
+dependencies = ["pygments"]
+readme = "README.md"
+
+
+[project.entry-points."pygments.lexers"]
+shellconsole_lexer = "shellconsole_lexer:ShellConsoleLexer"
+
+# [project.entry-points."pygments.formatters"]
+# example_formatter = "example_formatter:ExampleFormatter"
+
+[project.entry-points."pygments.styles"]
+shellconsole-style = "shellconsole_style:ShellConsoleStyle"
+
+# [project.entry-points."pygments.filters"]
+# example-filter = "example_filter:ExampleFilter"
+
+[tool.hatch.build.targets.wheel]
+packages = ["."]

pygments_shell_console-0.0.1/shellconsole_lexer.py

@@ -0,0 +1,150 @@
+"""An example plugin lexer for Pygments."""
+
+from pygments.lexer import Lexer
+from pygments.lexer import RegexLexer, ExtendedRegexLexer, include, bygroups, \
+    default, using, line_re, do_insertions
+from pygments.token import Token, Punctuation, Whitespace, \
+    Text, Comment, Operator, Keyword, Name, String, Number, Generic
+from pygments.lexers.diff import DiffLexer
+from pygments.lexers.shell import BashLexer
+from pygments.lexers.diff import DiffLexer
+from git_lexer import GitLexer
+from pygments.token import STANDARD_TYPES
+
+import re
+
+__all__ = ['ShellConsoleLexer']
+
+STANDARD_TYPES.update({
+    Token.Generic.Prompt.UserHost: 'gp-uh',
+    Token.Generic.Prompt.Directory: 'gp-d',
+    Token.Generic.Prompt.GitBranch: 'gp-gb',
+    Token.Generic.Prompt.VirtualEnv: 'gp-ve',
+})
+
+class ShellConsoleLexer(Lexer):
+    name = "Shell Console"
+    aliases = ["shellconsole", "shell-console", "shell", "console"]
+    filenames = ['*.sh-session', '*.shell-session']
+    mimetypes = ['application/x-shell-session', 'application/x-sh-session']
+    url = 'https://en.wikipedia.org/wiki/Unix_shell'
+    version_added = '1.0'
+
+    _bare_continuation = False
+    _venv = re.compile(r'^(\([^)]*\))(\s*)')
+
+    _ps1rgx = re.compile(
+        r'^\[?(?P<user_host>[^\s@]+@[^\s]+?)(?:\s+|\:)(?P<current_dir>[^\s\]]+)(?:\s+(?P<git_branch>\([^)]+\)))?\]?\s*[$#%]\s*(?P<command>.*\n?)')
+    _ps1_groups = [Token.Generic.Prompt.UserHost, Token.Generic.Prompt.Directory, Token.Generic.Prompt.GitBranch]
+
+
+    _ps2 = '> '
+    _innerLexerCls = BashLexer
+
+
+    def get_tokens_unprocessed(self, text):
+        innerlexer = self._innerLexerCls(**self.options)
+        difflexer = DiffLexer()
+        gitlexer = GitLexer()
+
+        pos = 0
+        # Bash command
+        curcode = ''
+        insertions = []
+        backslash_continuation = False
+        diff_continuation = False
+        git_continuation = False
+
+        for match in line_re.finditer(text):
+            line = match.group()
+
+            # Check for virtualenv prompt
+            venv_match = self._venv.match(line)
+            if venv_match:
+                venv = venv_match.group(1)
+                venv_whitespace = venv_match.group(2)
+                insertions.append((len(curcode),
+                                   [(0, Generic.Prompt.VirtualEnv, venv)]))
+                if venv_whitespace:
+                    insertions.append((len(curcode),
+                                       [(0, Text, venv_whitespace)]))
+                line = line[venv_match.end():]
+
+            m = self._ps1rgx.match(line)
+            ## If line starts with a prompt
+            if m:
+                # To support output lexers (say diff output), the output
+                # needs to be broken by prompts whenever the output lexer
+                # changes.
+                diff_continuation = False
+                git_continuation = False
+
+                if not insertions:
+                    pos = match.start()
+
+                prompt_pos = 0
+                for i, t in enumerate(self._ps1_groups):
+                    if m.group(i + 1):
+                        group_pos = m.start(i + 1)
+                        before_content = line[prompt_pos:group_pos]
+                        insertions.append((len(curcode), [(0, Generic.Prompt, before_content)]))
+
+                        insertions.append((len(curcode), [(0, t, m.group(i + 1))]))
+                        prompt_pos += len(before_content) + len(m.group(i+1))
+
+                group_pos = m.start(4)
+                before_content = line[prompt_pos:group_pos]
+                insertions.append((len(curcode), [(0, Generic.Prompt, before_content)]))
+
+                curcode += m.group(4)
+                backslash_continuation = curcode.endswith('\\\n')
+
+            # If line is a continuation of a previous line
+            elif backslash_continuation:
+                # If there is a continuation prompt, insert it
+                if line.startswith(self._ps2):
+                    insertions.append((len(curcode),
+                                       [(0, Generic.Prompt,
+                                         line[:len(self._ps2)])]))
+                    curcode += line[len(self._ps2):]
+                else:
+                    curcode += line
+                backslash_continuation = curcode.endswith('\\\n')
+
+            # If line is a continuation of a previous line with bare_continuation
+            elif self._bare_continuation and line.startswith(self._ps2):
+                insertions.append((len(curcode),
+                                   [(0, Generic.Prompt,
+                                     line[:len(self._ps2)])]))
+                curcode += line[len(self._ps2):]
+
+            # Otherwise, we have a normal line
+            else:
+                # Add insertions to the current code
+                if insertions:
+                    toks = innerlexer.get_tokens_unprocessed(curcode)
+                    for i, t, v in do_insertions(insertions, toks):
+                        # print(f"\n1. yielding pos={pos+i}, t={t}, v={v}")
+                        yield pos+i, t, v
+
+                if line.startswith('diff ') or diff_continuation:
+                    diff_continuation = True
+                    for i, t, v in difflexer.get_tokens_unprocessed(line):
+                        # print(f"\n2. yielding pos={match.start()+i}, t={t}, v={v}")
+                        yield match.start()+i, t, v
+                elif curcode.startswith('git') or git_continuation:
+                    git_continuation = True
+                    for i, t, v in gitlexer.get_tokens_unprocessed(line):
+                        # print(f"\n2. yielding pos={match.start()+i}, t={t}, v={v}")
+                        yield match.start()+i, t, v
+                else:
+                    # print(f"\n3. yielding pos={match.start()}, t={Generic.Output}, v={line}")
+                    yield match.start(), Generic.Output, line
+                insertions = []
+                curcode = ''
+
+        if insertions:
+            for i, t, v in do_insertions(insertions,
+                                         innerlexer.get_tokens_unprocessed(curcode)):
+                # print(f"\n4. yielding pos={pos+i}, t={t}, v={v}")
+                yield pos+i, t, v

pygments_shell_console-0.0.1/shellconsole_style.py

@@ -0,0 +1,23 @@
+"""An example plugin style for Pygments."""
+
+from pygments.style import Style
+from pygments.token import Token, Punctuation, Whitespace, \
+    Text, Comment, Operator, Keyword, Name, String, Number, Generic
+from pygments.styles.default import DefaultStyle
+
+class ShellConsoleStyle(Style):
+    styles = DefaultStyle.styles.copy()
+    styles.update({
+        Generic.Prompt.UserHost: "#008000",
+        Generic.Prompt.Directory: "#19177C",
+        Generic.Prompt.GitBranch: "#767600",
+        Generic.Prompt.VirtualEnv: "#800000",
+
+        Token.Git.BranchLine: "#f00",
+        Token.Git.CommitHash: "#00f",
+        Token.Git.CommitDate: "#008000",
+        Token.Git.CommitMessage: "#FFFFFF",
+        Token.Git.CommitAuthor: "#aaaaaa",
+        Token.Git.Refs: "#00ffff",
+    })
+    del styles[Token.Generic.Prompt]

pygments_shell_console-0.0.1/test.exmpl

@@ -0,0 +1,27 @@
+joapuiib@FP:~/git_tutorial (main) $ echo "Hello world!"
+(venv) joapuiib@FP:~/git_tutorial (main) $ git diff
+diff --git a/README.md b/README.md
+index 6d747b3..ff524e4 100644
+--- a/README.md
++++ b/README.md
+@@ -1,2 +1,4 @@
+ # Tutorial de Git
+ Estem aprenent a utilitzar Git!
++
++Hem modificat un fitxer existent.
+-Hem eliminat un fitxer.
+joapuiib@FP:~/git_tutorial (main) $ git push
+Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
+To /home/joapuiib/gitflow_example/remot
+   0fb88ef..9e34bb0  develop -> develop
+joapuiib@FP:~/git_tutorial (main) $ git lga
+* f853946 - (7 minutes ago) README: Afegits autors - Mar (origin/feature/author)
+| * cc8c388 - (9 minutes ago) LICENSE: Afegida llicència - Pau (origin/feature/license)
+|/  
+| * 9e34bb0 - (15 minutes ago) README: Afegida descripció del projecte - Anna (HEAD -> develop, origin/develop, feature/readme, origin/feature/readme)
+|/  
+* 0fb88ef - (29 minutes ago) 1. Primer commit - Joan Puigcerver (origin/main, origin/HEAD, main)
+[user@host ~ (main)] $ echo "Hello, world!"
+(venv) [user@host ~] $ echo "Hello, world!"
+(example) $ ls -l
+