pyodide-mkdocs-theme 5.5.6__tar.gz → 5.6.0__tar.gz

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyodide-mkdocs-theme
-Version: 5.5.6
+Version: 5.6.0
 Summary: Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations
 License: GPL-3.0-or-later
 Keywords: mkdocs,mkdocs-plugin,pyodide,IDE,terminal

pyodide_mkdocs_theme-5.6.0/pyodide_mkdocs_theme/__version__.py

@@ -0,0 +1 @@
+__version__ = "5.6.0"

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/basthon_p5_to_pmt.py

@@ -211,7 +211,6 @@ def update_basthon_p5_code(file:str, target:str, tail:str=None):
 
     source_code = py_file.read_text(encoding='utf-8')
 
-
     # Determine the output file name:
     i_end = None
     tail  = tail or '_pmt'
@@ -223,22 +222,18 @@ def update_basthon_p5_code(file:str, target:str, tail:str=None):
 
     print('Convert:', py_file, 'to', out_name)
 
-
     # First pass to update each p5 name to p5.name:
     p5_code, tree = update_code_with_nodes(source_code, find_p5_names, name_transform)
 
-
     # Second pass to update the `run` calls:
     run_call   = find_runs_signature_call(tree, target)
     out_code,_ = update_code_with_nodes(p5_code, find_p5_run_calls, run_transformer(run_call))
     out_code   = out_code.replace('from p5 import *', "import p5")
 
-
     # Show useful info to the user:
     P5Visitor().visit(ast.parse(out_code))
     P5Visitor.show_messages(run_call)
 
-
     # Dump the fixed file, in the same folder:
     out_file.write_text(out_code, encoding='utf-8')
 

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/files_extractors/_inclusions_tools.py

@@ -266,7 +266,7 @@ class InclusionConfig:
         if not rel_path:
             raise PmtMacrosInvalidPmtFileError(
                 "Inclusions using `[md]` or `[cwd]` require to specify a relative path information "
-                f"(aka, `py_name`).\nOccurred in:\n{ self.parent.env.log() }"
+                f"(aka, `py_name`).\nFile containing the error: { self.parent.exo_file }"
             )
 
         as_path = Path(rel_path)
@@ -278,8 +278,8 @@ class InclusionConfig:
 
         if not runner_file:
             raise PmtMacrosInvalidPmtFileError(
-                f"No file matching {(redirect or '')+rel_path!r} could be found, starting from "
-                f"the { source.parent } directory."
+                f"No file matching {(redirect or '')+rel_path!r} could be found, starting from the"
+                f" { source.parent } directory.\nFile containing the error: { self.parent.exo_file }"
             )
 
         _, child = self.parent.get_file_extractor_for(

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/html_builder/__init__.py

@@ -40,6 +40,7 @@ from ._html_builder import (
     button,
     code,
     div,
+    label,
     script,
     style,
     span,

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/html_builder/_html_builder.py

@@ -21,8 +21,8 @@ If not, see <https://www.gnu.org/licenses/>.
 
 from typing import Any, Dict, Optional
 
-from ..exceptions import PmtInternalError
 from ..tools_and_constants import HtmlClass
+from ..parsing import admonition_safe_html
 
 
 
@@ -31,9 +31,8 @@ def _build_html_attributes(
     id:str,
     kls:str,
     attrs: Dict[str, str],
-    # disabled: Any=None,
-    # checked: Any=None,
-    kwargs: Dict[str,Any],
+    kwargs: Dict[str,Any],    # NOTE: content overrides attrs values
+    # Supported through @kwargs or attrs:   disabled, checked, for_
 ):
     """
     Build a string with all the desired html attributes for an opening tag.
@@ -53,6 +52,14 @@ def _build_html_attributes(
     attrs.update(kwargs)
     if id:  attrs['id'] = id
     if kls: attrs['class'] = kls
+    if attrs.get('for_'):
+        attrs['for'] = attrs.pop('for_')
+
+    style = attrs.get('style')
+    if style and not isinstance(style, str):
+        raise ValueError(
+            f'The `style` argument should be given as a string, but was:\n{style!r}'
+        )
 
     if 'data' in attrs:
         data: Dict = attrs.pop('data')
@@ -114,13 +121,14 @@ a       = bi_tag('a')
 button  = bi_tag('button', type='button') # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#notes
 code    = bi_tag('code')
 div     = bi_tag('div')
+label   = bi_tag('label')
 script  = bi_tag('script')
 style   = bi_tag('style')
 span    = bi_tag('span')
 svg     = bi_tag('svg')
 td      = bi_tag('td')
 
-
+_label = label  # To access the function from within the checkbox one, which has a label argument...
 
 
 
@@ -147,45 +155,50 @@ def checkbox(
     checked:bool,
     *,
     label:str="",
-    id:str = "none",
+    id:str = "",
     kls:str = "",
     kls_box:str = "",
     tip_txt:str = "",
-    width_em:Optional[int]=None,
-    tip_shift:Optional[int]=None,
-    bare_tip: bool = False
+    tip_width:Optional[int]=None,
+    disabled: bool = False,
+    box_left:bool = True
 ):
     """
     Build a checkbox with a PMT tooltip attached, and an optional label after it.
-    If @bare_tip is True and there is no given label, attach the tooltip info as dataset
-    directly on the input.
+    * @kls is on the outer element (whatever it is...)
+    * if @label is given, the checkbox is wrapped with a span element containing the
+    label and the checkbox
     """
-    input_kw = {'checked':""} if checked else {}
+    box_kw = {}
+    if checked:  box_kw['checked'] = ""
+    if disabled: box_kw['disabled'] = ""
+
+    tip_kw = {}
+    if tip_txt:
+        tip_kw['data-tip-txt'] = tip_txt
+        if tip_width is not None:
+            tip_kw['data-tip-width'] = tip_width
+
+    tip_box, tip_label = ({},tip_kw) if label else (tip_kw,{})
 
-    if bare_tip:
-        if label or kls:
-            raise PmtInternalError(
-                "A checkbox built with @bare_tip=True shouldn't have a label or a class for any outer element."
-            )
-        dct = {}
-        if tip_txt:
-            dct['data-tip-txt'] = tip_txt
-            if width_em is not None: dct['data-tip-width'] = width_em
-        input_kw.update(dct)
-        kls_box = f"{ kls_box } { HtmlClass.tooltip }".lstrip()
-    else:
-        txt = label and span(label)
-        tip = tooltip(tip_txt, width_em, shift=tip_shift)
+    kls_box = f"{ kls_box } { HtmlClass.tooltip * bool(tip_txt) }".strip()
+    box = input('', type='checkbox', id=id, kls=kls_box, **tip_box, **box_kw)
 
-    box = input('', type='checkbox', disabled=True, id=id, kls=kls_box, **input_kw)
-    return box if bare_tip else div( box+txt+tip, kls=f'{ HtmlClass.tooltip } { kls }'.rstrip() )
+    if label:
+        side_margin = 'left' if box_left else 'right'
+        box = _label(
+            box*box_left + span(label, style=f'margin-{side_margin}:10px') + box*(not box_left),
+            kls=f"{ kls } { HtmlClass.tooltip * bool(tip_txt) }".strip(),
+            for_=id, **tip_label,
+        )
+    return box
 
 
 
 
 
 
-SVG_BOX_TEMPLATE = '''\
+SVG_BOX_TEMPLATE = admonition_safe_html('''\
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <svg {attrs} viewBox="0 0 12 12" role="img" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg" style="stroke-width:1.25;stroke-linecap:round">
 <path class="bgd-svg" style="fill:var(--qcm-fill);stroke:none;" d="M 5.93,1.93 3.29,2.40 2.70,2.75 1.86,5.70 2.38,8.76 2.75,9.29 5.82,10.13 9.07,9.45 9.36,9.13 10.12,6.11 9.49,2.93 9.12,2.65 Z"></path>
@@ -197,7 +210,7 @@ SVG_BOX_TEMPLATE = '''\
  </g>
 </g>
 <g style="fill:none;stroke:var(--qcm-border)">{shape}</g>
-</svg>'''
+</svg>''')
 CIRCLE_QCS = '<circle cy="6" cx="6" r="4.2"></circle>'
 SQUARE_QCM = '<rect width="7.41" height="7.36" x="2.29" y="2.32"></rect>'
 
@@ -207,8 +220,18 @@ def svg_qcm_box(
     id: str = "",
     kls: str = "",
     attrs: Dict[str,Any] = None,
+    state:str=None,
+    tip_txt:str=None,
+    tip_width:float=None,
     **kwargs
 ):
+    if tip_txt:
+        kls = 'tooltip '+kls
+        kwargs['data-tip-txt'] = tip_txt
+    if tip_width is not None:
+        kwargs['data-tip-width'] = tip_width
+    if state is not None:
+        kwargs['data-state'] = state
     shape = SQUARE_QCM if is_multi else CIRCLE_QCS
     attributes = _build_html_attributes(id, f'qcm {kls}'.rstrip(), attrs, kwargs)
     return SVG_BOX_TEMPLATE.format(attrs=attributes, shape=shape)

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/html_dependencies/deps.py

@@ -203,14 +203,14 @@ class HtmlDependencies:
     jsLogger           = Cdn(Block.libs, DepKind.always, "{base_url}/js-libs/jsLogger.js", type="module")
     mathjax            = Cdn(Block.libs, DepKind.always, "{base_url}/js-libs/mathjax-libs.js", type="text/javascript")
     process_and_gui    = Cdn(Block.libs, DepKind.always, "{base_url}/js-libs/process_and_gui.js", type="module")
-    generic            = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/0-generic.css")
-    header             = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/btns-header.css")
-    history            = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/history.css")
-    hourglass          = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/hourglass.css")
-    ide                = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/ide.css")
-    qcm                = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/qcm.css")
-    terminal           = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/terminal.css")
-    testing            = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/testing.css")
+    css_generic        = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/0-generic.css")
+    css_header         = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/btns-header.css")
+    css_history        = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/history.css")
+    css_hourglass      = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/hourglass.css")
+    css_ide            = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/ide.css")
+    css_qcm            = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/qcm.css")
+    css_terminal       = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/terminal.css")
+    css_testing        = Css(Block.libs, DepKind.always, "{base_url}/pyodide-css/testing.css")
     # GENERATED-libs
     #^^^^^^^^^^^^^^^
 
@@ -234,6 +234,8 @@ class HtmlDependencies:
     idesManager     = Cdn(Block.content, DepKind.ide,       "{base_url}/js-per-pages/4-0-idesManager-ide.js", type="module")
     ideLogistic     = Cdn(Block.content, DepKind.ide,       "{base_url}/js-per-pages/4-ideLogistic-ide.js", type="module")
     ideRunner       = Cdn(Block.content, DepKind.ide,       "{base_url}/js-per-pages/4-ideRunner-ide.js", type="module", pool="Ide")
+    virtualizer     = Cdn(Block.content, DepKind.ides_test, "{base_url}/js-per-pages/5-2-virtualizer-ides_test.js", type="module")
+    avl             = Cdn(Block.content, DepKind.ides_test, "{base_url}/js-per-pages/5-3-avl-ides_test.mjs", type="module")
     ideTester       = Cdn(Block.content, DepKind.ides_test, "{base_url}/js-per-pages/5-ideTester-ides_test.js", type="module", pool="IdeTester")
     init            = Cdn(Block.content, DepKind.playground, "{base_url}/js-per-pages/6-2-init-playground.js", type="module")
     idePlayground   = Cdn(Block.content, DepKind.playground, "{base_url}/js-per-pages/6-idePlayground-playground.js", type="module", pool="IdePlayground")

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_ide.py

@@ -31,11 +31,11 @@ from pyodide_mkdocs_theme.pyodide_macros.html_dependencies.deps_class import Dep
 
 
 from .. import html_builder as Html
-from ..tools_and_constants import HtmlClass, PmtCte, IdeMode, PmtPyMacrosName, Prefix
+from ..tools_and_constants import HtmlClass, PmtCte, IdeMode, PmtPyMacrosName, Prefix, NamedTestCase
 from ..messages import Tip
 from ..parsing import add_indent, admonition_safe_html, build_code_fence, items_comma_joiner
 from ..plugin_tools.test_cases import Case
-from ..plugin_tools.macros_data import IdeToTest
+from ..plugin_tools.ide_tests import IdeTests
 from ..plugin_config import PLUGIN_CONFIG_SRC
 
 from .ide_term_ide import CommonTermIde
@@ -75,6 +75,9 @@ class Ide(CommonTermIde):
         (what an awful interface, yeah... x) )
     """
 
+    IS_TESTED: ClassVar[bool] = True
+    """ True if the IDE is supposed to end up in the `test_ides` page. """
+
     NEED_INDENTS: ClassVar[bool] = True
 
     MACRO_NAME: ClassVar[PmtPyMacrosName] = PmtPyMacrosName.IDE
@@ -189,25 +192,13 @@ class Ide(CommonTermIde):
 
     def __post_init__(self):
         super().__post_init__()
-        self.register_ide_for_tests()
-
-
-
-    def register_ide_for_tests(self):
-        """
-        Archive config info about the current IDE and register for testing...
-        """
-        case = Case.auto_convert_str_to_case(self.test_config)
-
-        some_to_test = self.has_code if case.code else self.has_corr
-        fallback     = self.env.testing_empty_section_fallback
-        if not some_to_test and fallback:
-            setattr(case, fallback, True)
 
-        self.test_config = case
+        if not self.IS_TESTED:
+            return
 
-        test = IdeToTest.from_ide(self)
-        self.env.archive_ide_to_tests(test)
+        self.test_config = Case.auto_convert_and_fix_case(self)
+        ide_tests = IdeTests.from_ide(self)
+        self.env.archive_ide_for_tests(ide_tests)
 
 
 

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_manager.py

@@ -788,6 +788,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         margin_right:  float = 0.2,
         extra_btn_kls: str   = "",
         tip_side:       P5BtnLocation = "",
+        tip_txt:        str = "",
         bare_tip:       bool = False,
         **kwargs
     ) -> str:
@@ -806,6 +807,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
             margin_right  = margin_right,
             extra_btn_kls = extra_btn_kls,
             tip_side      = tip_side,
+            tip_txt       = tip_txt,
             bare_tip      = bare_tip,
             **kwargs
         )
@@ -821,6 +823,7 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
         margin_right:   float = 0.2,
         extra_btn_kls:  str   = "",
         tip_side:       P5BtnLocation = "",
+        tip_txt:        str = "",
         bare_tip:       bool = False,
         **kwargs
     ) -> str:
@@ -843,14 +846,15 @@ class IdeManagerMdHtmlGenerator(IdeSectionsManager):
 
         img = Html.img(src=img_link, kls=HtmlClass.skip_light_box, **img_style)
 
-        tip_txt: Tip = getattr(env.lang, lang_prop)
+        tip: Tip = tip_txt or getattr(env.lang, lang_prop)
+        tip_width = None if tip_txt else tip.em
         if bare_tip:
             tip_span = ""
             kwargs['data'] = kwargs.get('data', {})
-            kwargs['data']['tip-txt'] = str(tip_txt)
-            if tip_txt.em: kwargs['data']['tip-width'] = tip_txt.em
+            kwargs['data']['tip-txt'] = str(tip)
+            if tip_width: kwargs['data']['tip-width'] = tip_width
         else:
-            tip_span = Html.tooltip(tip_txt, tip_txt.em, tip_side=tip_side or P5BtnLocation.bottom)
+            tip_span = Html.tooltip(tip, tip_width, tip_side=tip_side or P5BtnLocation.bottom)
 
         btn_style = f"margin-left:{margin_left}em; margin-right:{ margin_right }em;"
         if 'style' in kwargs:
@@ -887,6 +891,7 @@ BTNS_KINDS_CONFIG = {
     'show':       ('check',      'show',         'gray'),
 
     'test_ides':  ('play',       'test_ides',    'orange'),
+    'test_pause': ('pause',      'test_pause',   'orange'),
     'test_stop':  ('stop',       'test_stop',    'orange'),
     'test_1_ide': ('play',       'test_1_ide',   'orange'),
     'load_ide':   ('download',   'load_ide',     None),

{pyodide_mkdocs_theme-5.5.6 → pyodide_mkdocs_theme-5.6.0}/pyodide_mkdocs_theme/pyodide_macros/macros/ide_playground.py

@@ -42,6 +42,8 @@ class IdePlayground(CommonGeneratedIde, Ide):
 
     DEPS_KIND: ClassVar[DepKind] = DepKind.playground
 
+    IS_TESTED: ClassVar[bool] = False
+
 
     @property
     def has_check_btn(self):
@@ -64,19 +66,17 @@ class IdePlayground(CommonGeneratedIde, Ide):
         return False
 
 
-
     def exported_items(self):
+        """
+        Override the exported values, making sure deactivate_stdout_for_secrets is always
+        false in the playground (otherwise, it becomes mainly useless...).
+        """
         yield from (
             (k,v) if k!='deactivate_stdout_for_secrets' else (k, False)
             for k,v in super().exported_items()
         )
 
 
-
-    def register_ide_for_tests(self):
-        """ IdeTester instances are never registered for testing... """
-
-
     # def list_of_buttons(self):
     #     """ Keep only public tests, validations and restart. """
     #     btns    = super().list_of_buttons()
@@ -84,7 +84,6 @@ class IdePlayground(CommonGeneratedIde, Ide):
     #     return btns[:2] + [restart]
 
 
-
     #-----------------------------------------------------------------------------------
 
 
@@ -117,16 +116,23 @@ class IdePlayground(CommonGeneratedIde, Ide):
 # Playground  {{ data-search-exclude }}
 
 
-Cette page permet de développer dynamiquement dans un contexte où les différentes sections sont
-modifiables et exécutables à volonté : lorsque l'IDE est exécuté, les contenus de tous les autres
-éditeurs de la page sont utilisés en tant que sections de l'IDE.
+Cette page permet de développer dynamiquement dans un contexte où les différentes
+[`sections`]({ GIT_LAB_PAGES }redactors/IDE-details/#ide-sections) sont modifiables et exécutables
+à volonté : lorsque l'IDE est exécuté, les contenus de tous les autres éditeurs de la page sont
+utilisés en tant que sections de l'IDE.
+
+Elle permet donc d'accélérer la création et le débogage des codes pythons pour un exercice, sans
+avoir besoin de passer par de multiples pipelines ou `mkdocs serve`.
+
+<br>
 
+* <span style="color:orange" markdown>___Le bouton de téléversement de l'IDE permet d'importer un fichier existant pour
+ensuite en modifier les différentes sections.___</span>
+* <span style="color:orange" markdown>___Le bouton de téléchargement de l'IDE permet de récupérer un fichier PMT correctement
+formaté, avec toutes les sections assemblées.___</span>
+* Toutes les [`python_libs`]({ GIT_LAB_PAGES }custom/python_libs/) du site sont utilisables dans l'IDE.
 * Les raccourcis ++ctrl+s++ (tests publics) et ++ctrl+enter++ (validation) sont actifs dans
 n'importe quel éditeur de la page.
-* Le bouton de téléversement permet d'importer un fichier existant pour ensuite en modifier
-les différentes sections.
-* Le bouton de téléchargement sous l'IDE permet de récupérer un fichier PMT correctement formaté,
-avec toutes les sections assemblées.
 * Le contenu de la section `tests` est automatiquement exécuté après le contenu de l'IDE : il n'est
 pas nécessaire d'en rajouter le code dans celui-ci pour retrouver le comportement habituel des IDEs
 normaux, que ce soit pour les tests publics ou les validations.
@@ -138,10 +144,11 @@ normaux, que ce soit pour les tests publics ou les validations.
 
 <br>
 
-??? help "Aide..."
-    - [Configuration]({ GIT_LAB_PAGES }custom/config/#pyodide_macros.playground) de la page Playground.
-    - Informations sur les différentes [`sections`]({ GIT_LAB_PAGES }redactors/IDE-details/#ide-sections)
-    et leurs comportements
+???+ help "Configurer et utiliser la page Playground sur votre site ?"
+
+    La page décrivant les options de configuration de la page Playground :
+
+    [`Utilisations avancées/configuration`]({ GIT_LAB_PAGES }custom/config/#pyodide_macros.playground)
 
 <br>