upstream/ipython Files · IPython/lib/tests/test_pygments.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Nicholas Bollweg - - Load All Authors

File last commit:

r27909:017b677e


                r28197:ad452c1d

Download file

             test_pygments.py
        
                    26 lines
            
             | 824 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / lib / tests / test_pygments.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      from typing import List

      import pytest

      import pygments.lexers

      import pygments.lexer

      from IPython.lib.lexers import IPythonConsoleLexer, IPythonLexer, IPython3Lexer

      #: the human-readable names of the IPython lexers with ``entry_points``

      EXPECTED_LEXER_NAMES = [

          cls.name for cls in [IPythonConsoleLexer, IPythonLexer, IPython3Lexer]

      ]

      @pytest.fixture

      def all_pygments_lexer_names() -> List[str]:

          """Get all lexer names registered in pygments."""

          return {l[0] for l in pygments.lexers.get_all_lexers()}

      @pytest.mark.parametrize("expected_lexer", EXPECTED_LEXER_NAMES)

      def test_pygments_entry_points(

          expected_lexer: str, all_pygments_lexer_names: List[str]

      ) -> None:

          """Check whether the ``entry_points`` for ``pygments.lexers`` are correct."""

          assert expected_lexer in all_pygments_lexer_names

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				from typing import List

				import pytest
				import pygments.lexers
				import pygments.lexer

				from IPython.lib.lexers import IPythonConsoleLexer, IPythonLexer, IPython3Lexer

				#: the human-readable names of the IPython lexers with ``entry_points``
				EXPECTED_LEXER_NAMES = [
				cls.name for cls in [IPythonConsoleLexer, IPythonLexer, IPython3Lexer]
				]


				@pytest.fixture
				def all_pygments_lexer_names() -> List[str]:
				"""Get all lexer names registered in pygments."""
				return {l[0] for l in pygments.lexers.get_all_lexers()}


				@pytest.mark.parametrize("expected_lexer", EXPECTED_LEXER_NAMES)
				def test_pygments_entry_points(
				expected_lexer: str, all_pygments_lexer_names: List[str]
				) -> None:
				"""Check whether the ``entry_points`` for ``pygments.lexers`` are correct."""
				assert expected_lexer in all_pygments_lexer_names