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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyodide-mkdocs-theme
-Version: 5.5.4
+Version: 5.5.6
 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.5.6/pyodide_mkdocs_theme/__version__.py

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

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/pyodide_macros/plugin/maestro_base.py

@@ -289,6 +289,7 @@ class BaseMaestro(BasePlugin[PyodideMacrosConfig]):
     testing_page:                   str = ConfigExtractor('config.testing', prop='page')
 
     _dev_mode:               bool = ConfigExtractor('config')
+    allow_theme_extension:   bool = ConfigExtractor('config')
     force_render_paths:       str = ConfigExtractor('config')
     include_dir:              str = ConfigExtractor('config')
     include_yaml:       List[str] = ConfigExtractor('config')

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/pyodide_macros/plugin/maestro_contracts.py

@@ -33,19 +33,21 @@ from collections import defaultdict
 from mkdocs.config.defaults import MkDocsConfig
 
 
-
 from ...__version__ import __version__
 from ..exceptions import PmtMacrosContractError
 from ..paths_utils import get_local_projects_data_tracking_file_location
 from ..tools_and_constants import HashPathMode, MultiProjectFeedbackLevel, MyEnum, PmtCte
 from ..pyodide_logger import logger
 from .config import PLUGIN_CONFIG_SRC, GIT_LAB_PAGES
+from ..files_extractors.concrete_extractors import FileExtractor
 from .maestro_base import BaseMaestro
 
 
 
 
 
+
+
 @dataclass
 class Props:
     """ (helper, to centralize all values/names) """
@@ -339,24 +341,25 @@ class MaestroContracts(MaestroContractsMultiProjects):
         # Validation is done on the individual/current segments of the paths, so that an invalid
         # directory name is not affecting the validation of its children:
         for path,dirs,files in os.walk(self.docs_dir):
-
-            files_to_check = [ file for file in files if re.search(r'\.(py|md)$', file)]
+            extensions = '|'.join(FileExtractor.EXTENSION_TO_EXTRACTOR_CLASS).replace('.', '')
+            file_pattern = re.compile(fr"\.({ extensions }|md)$")
+            files_to_check = [ file for file in files if file_pattern.search(file)]
 
             for segment in dirs + files_to_check:
-                invalids = frozenset(invalid_chars.findall(segment))
+                invalids = frozenset(''.join(invalid_chars.findall(segment)))
                 if invalids:
                     wrongs[invalids].append( os.path.join(path,segment) )
 
         if wrongs:
             msg = ''.join(
-                f"\nInvalid characters {repr(''.join(sorted(invalids)))} found in these filepaths:"
+                f"\nInvalid characters {''.join(sorted(invalids))!r} found in these filepaths:"
                 + "".join(f"\n\t{ path }" for path in sorted(lst))
                 for invalids,lst in wrongs.items()
             )
             raise PmtMacrosContractError(
-                f"{ msg }\nPython and markdown files, and their parent directories' names "
+                f"{ msg }\nCodes and markdown files, as well as their parent directories' names "
                 'should only contain alphanumerical characters (no accents or special chars), '
-                "dots, underscores, and/or hyphens."
+                "dots, underscores or hyphens."
             )
 
 
@@ -404,39 +407,36 @@ class MaestroContracts(MaestroContractsMultiProjects):
                 * `{theme.name}/search`  <-  `mkdocs.yml:plugins: - search`
                 * `{some}/search`        <-  `mkdocs.yml:plugins: - {some}/search`
         """
-        errors       = []
-        material     = 'material'
-        pmt          = 'pyodide-mkdocs-theme'
-        theme        = config.theme.name
-        is_extension = theme and theme not in (material, pmt, None)
-        registered   = RegisteredPlugin.convert(config.plugins)
-
-
-        if not theme or theme==material:
-            errors.append(
-                f"The { pmt }'s plugin is registered, so `theme.name` should be set "
-                f"to `{ pmt }` instead of `{ theme }`."
-            )
+        errors = []
+        pmt    = 'pyodide-mkdocs-theme'
+        theme  = config.theme.name
+        material_plugins = RegisteredPlugin.get_material_plugins(config.plugins)
 
         features = config.theme.get('features', ())
         if 'navigation.instant' in features:
             errors.append(
-                "Remove `navigation.instant` from `mkdocs.yml:theme.features`. "
-                "It is not compatible with the pyodide-mkdocs-theme."
+                f"`mkdocs.yml:theme.features.navigation.instant` is not compatible with { pmt } "
+                "and should be removed."
             )
 
-        for plug in registered:
-            if plug.prefix != theme:
-                errors.append(
-                    f"The `{ plug.qualname }` plugin should be registered " + (
-                        f"with `pyodide-mkdocs-theme/{ plug.name }`."
-                            if is_extension else
-                        f"using `{ plug.name }` only{ ' (PMT >= 2.2.0)' * (theme==pmt) }."
-                    )
-                )
+        if theme != pmt and not self.allow_theme_extension:
+            errors.append(
+                f"The { pmt }'s plugin is activated, so `mkdocs.yml:theme.name` should be set "
+                f"to `{ pmt }` instead of `{ theme }`. If you are extending {pmt}, you also "
+                f"need do set {PLUGIN_CONFIG_SRC.get_plugin_path('allow_theme_extension')} to "
+                "`true` to deactivate this security check."
+            )
+        errors.extend(
+            f"The `{ plugin.qualname }` plugin should be registered as " + (
+                f"`{ pmt }/{ plugin.name }`."
+                    if theme!=pmt else
+                f"`{ plugin.name }` only (PMT >= 2.2.0)."
+            )
+            for plugin in material_plugins if plugin.prefix != pmt
+        )
 
         if errors:
-            str_errors = ''.join(map( '\n  {}'.format, errors ))
+            str_errors = ''.join(map( '\n\n  {}'.format, errors ))
             raise PmtMacrosContractError(
                 f"Invalid theme or material's plugins configuration(s):{ str_errors }"
             )
@@ -457,7 +457,7 @@ class MaestroContracts(MaestroContractsMultiProjects):
 @dataclass
 class RegisteredPlugin:
     """
-    Represents an mkdocs plugin name, with information about how it's built.
+    Represents a material plugin name, with information about how it's built.
     """
 
     qualname: str
@@ -481,13 +481,12 @@ class RegisteredPlugin:
 
 
     @classmethod
-    def convert(cls, plugins:Iterable[str]) -> List['RegisteredPlugin'] :
+    def get_material_plugins(cls, plugins:Iterable[str]) -> List['RegisteredPlugin'] :
         pattern = re.compile(
             f"(?:(?P<prefix>\\w*)/)?(?P<name>{ '|'.join(cls.MATERIAL_PLUGINS) })"
         )
         registered = [
             RegisteredPlugin(m[0], m['name'], m['prefix'])
-                for m in map(pattern.fullmatch, plugins)
-                if m
+            for m in filter(bool, map(pattern.fullmatch, plugins))
         ]
         return registered

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/pyodide_macros/plugin_config/definitions/plugin_config.py

@@ -61,13 +61,13 @@ CommonTreeSrc.DEFAULT_DOCS_URL_TEMPLATE = to_page(DOCS_CONFIG) / '{get_md_link}'
 
 PLUGIN_CONFIG_SRC = PluginConfigSrc(
     extra_docs = """
-        La configuration du plugin, `PyodideMacrosConfig`, reprend également toutes les options du
-        plugin original `MacrosPlugin`, ce qui permet d'en réutiliser toutes les fonctionnalités.
-        <br>Ces options, décrites succinctement ci-dessous, sont disponibles à la racine de la
+        Outre l'option `allow_theme_extension`, la configuration du plugin, `PyodideMacrosConfig`,
+        reprend également toutes les options du plugin original `MacrosPlugin`, ce qui permet d'en
+        réutiliser toutes les fonctionnalités.<br>
+        Ces options, décrites succinctement ci-dessous, sont disponibles à la racine de la
         configuration du plugin, dans `mkdocs.yml:plugins.pyodide_macros` (voir [en haut de cette
-        page](--global-architecture)).
-
-        Pour plus d'informations à leur sujet ou concernant le fonctionnement general des macros :
+        page](--global-architecture)). Pour plus d'informations à leur sujet ou concernant le
+        fonctionnement général des macros :
 
         - [GitHub repository][mkdocs-macros]{: target=_blank }
         - [Help page](https://mkdocs-macros-plugin.readthedocs.io/en/latest/){: target=_blank }
@@ -95,6 +95,14 @@ PLUGIN_CONFIG_SRC = PluginConfigSrc(
         yaml_desc="Run the plugin in development mode (...don't use that).",
     ),
 
+    ConfigOptionSrc(
+        'allow_theme_extension', bool, default=False,
+        extra_docs = """
+            Si `true`, la plupart des validation de `mkdocs.yml:theme`sont désactivées.
+        """,
+        yaml_desc="Bypass some theme configuration validations, allowing PMT's extension.",
+    ),
+
 
     # ---------------------------------------------------------------------------------------
     # Replication of MacrosPlugin options (merging the config_scheme properties programmatically

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/pyodide_macros/plugin_config/plugin_config_src.py

@@ -135,10 +135,10 @@ class PluginConfigSrc(SubConfigSrc):
         Verify that the config of the MacroPlugin class is still the expected one.
         """
         logger.debug("Check that the original MacrosPlugin implementation didn't change.")
-
+        excluded_options = '_dev_mode', 'allow_theme_extension'
         current_props = {
             prop for prop,obj in self.subs_dct.items()
-                 if isinstance(obj, ConfigOptionSrc) and prop!='_dev_mode'
+                 if isinstance(obj, ConfigOptionSrc) and prop not in excluded_options
         }
 
         src_macros_props     = set(SRC_MACROS_CONF)

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-libs/0-config.js

@@ -37,9 +37,6 @@ const SqBs = {
 
 const CONFIG = {
 
-    /**Number of entries kept in validations history. */
-    N_IDE_VALIDATIONS: 10,
-
     /* The following values are passed from python to JS through the main.html,
        once this script got loaded */
     //JS_CONFIG_DUMP

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-libs/functoolsStorage.js

@@ -78,7 +78,7 @@ export const showIdCollisionsIfAny=()=>{
  *  1) Redactors might store extra fields in the LocalStorage, so DO NOT cleanup the thing...
  *  2) This function is used in CodEx.
  * */
-export function getIdeDataFromStorage(editorId, ide=null){      // CodCap
+export function getIdeDataFromStorage(editorId, ide=null){      // CodCap override
 
   // Originally, the storage value was just the user's code, so keep extracting as this:
   let codeOrStorageAsStr = localStorage.getItem(editorId) || ""

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-libs/functoolsUi.js

@@ -253,6 +253,11 @@ export const aceEditorsDayNightReactivity=()=>{
 */
 
 
+export const resetFloatingTip=()=>{
+  $("#floating-tip").css({display: 'none', width: "unset"}).find("span.tooltiptext").text("")
+}
+
+const DEBUG_TOOLTIP = false
 
 
 /**Logistic for PMT "bare tooltips": They are automatically put in place when an element holds at
@@ -363,9 +368,9 @@ export const handlePmtTooltips=()=>{
 
   // Add the event listener to all tool tips, and mark them as handled (in case several
   // applications are done-> see MCQ):
-  tips.on('mouseleave', function(e){
-    floating.css({display: 'none', width: "unset"})
-    tipSpan.text("")
+  tips.on('mouseleave', function(){
+    if(DEBUG_TOOLTIP) return
+    resetFloatingTip()
 
   }).on('mouseenter', function(e){
     if(this.dataset.tipFloat){

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-libs/functoolsUiBuilder.js

@@ -17,6 +17,8 @@ along with this program.
 If not, see <https://www.gnu.org/licenses/>.
 */
 
+import { resetFloatingTip } from "functoolsUi"
+
 
 
 /**Build bare divs from the given strings.
@@ -114,7 +116,7 @@ const stuffWithTooltip = (tag, options, content) =>{
 
 /**Create a button with tooltip, just like the python _html_builder one (no event attached).
  * */
-export function buttonWithTooltip(options, content){    // CodCap
+export function buttonWithTooltip(options, content){    // CodCap override
     options = defaultOptions(options)
     options.noLabel = true
     return stuffWithTooltip('button', options, content)
@@ -125,7 +127,7 @@ export function buttonWithTooltip(options, content){    // CodCap
 /**Create a jQuery button WITHOUT bound event, holding the svg of one of the IDE's buttons.
  * No event attached.
  * */
-export const makeIdeJqButton = (kind, options) => {     // CodCap
+export const makeIdeJqButton = (kind, options) => {     // CodCap override
     const img = `<img src="${ CONFIG.buttonIconsDirectory }/icons8-${ kind }-64.png" />`
     return buttonWithTooltip(options, img)
 }
@@ -252,7 +254,7 @@ export const cancelEvent=(e)=>{
 
 
 
-export function buildJqHistoryBtn(                                  // CodCap
+export function buildJqHistoryBtn(                                  // CodCap override
     jHolder,        // jQuery element holding the contextmenu
     historyId,      // Id if the "contextmenu" element
     historyArr,     // [data]
@@ -261,13 +263,13 @@ export function buildJqHistoryBtn(                                  // CodCap
 ){
 
     const appendHistory=()=>{
+        resetFloatingTip()
+
         if(!historyArr.length || $('#'+historyId).length) return;
 
-        // Use button instead of div, so that focusout and co' are actually working...
         const jHist = $(
-            `<button id="${ historyId }" class="history-box"></button>`
+            `<div id="${ historyId }" class="history-box" tabindex="0"></div>`
         )
-
         jHist.append(
             historyArr.map(data=>{
                 const btn = $(`<button class="history-btn">${ itemSetupCbk?"":data }</button>`)

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-per-pages/4-0-idesManager-ide.js

@@ -33,6 +33,8 @@ export { RUNNERS_MANAGER }
 
 
 class GlobalZipExportIdesManager extends CONFIG.CLASSES_POOL.GlobalRunnersManager {
+  // Extension done this way to avoid the need to export the partent class...
+  // (a bit dirty, but helps a bit to actually encapsulate the actual Manager object)
 
   exportIdesAsZip(){
 

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-per-pages/4-ideRunner-ide.js

@@ -174,20 +174,15 @@ class IdeHistoryManager extends IdeAceManager {
   }
 
 
-  getTime(){
+  getTime(){     // CodCap override
     return (Date()+'').split(' GMT')[0].slice(-8)
   }
 
   /**Store the data of the current run/validation to this.validations.
    * */
-  pushValidation(code, done){     // CodCap
+  pushValidation(code, done){     // CodCap override
     const time = this.getTime()
     this.validations.push([done, time, code])
-
-    // Suppress entries that are too old:
-    if(this.validations.length > CONFIG.N_IDE_VALIDATIONS){
-      this.validations.splice(0, this.validations.length-CONFIG.N_IDE_VALIDATIONS)
-    }
   }
 
 
@@ -209,7 +204,7 @@ class IdeHistoryManager extends IdeAceManager {
   }
 
 
-  getIdeStateColor(done){     // CodCap
+  getIdeStateColor(done){     // CodCap override
     return !done ? "unset" : done<0 ? 'red' : 'green'
   }
 
@@ -403,7 +398,7 @@ class IdeFeedbackManager extends IdeHistoryManager {
    *  .show (=false):
    *      If true, deploy the admonition.
    * */
-  revealSolutionAndRems(options={}){    // CodCap
+  revealSolutionAndRems(options={}){    // CodCap override
     LOGGER_CONFIG.ACTIVATE && jsLogger("[CheckPoint] - Enter revealSolutionAndRems")
 
     const {waitForMathJax, show} = {
@@ -609,7 +604,7 @@ class IdeRunnerLogic extends IdeFeedbackManager {
 
 
 
-  async playThroughRunner(runtime){   // CodCap
+  async playThroughRunner(runtime){   // CodCap override
     const code = this.getCodeToTest()
     await this.runPythonCodeWithOptionsIfNoStdErr(code, runtime, CONFIG.section.editor)
   }
@@ -1006,7 +1001,7 @@ export class IdeRunner extends IdeRunnerLogic {
 
 
   // Doesn't work to catch the Esc applying "exit full screen"... :/
-  respondToKeyDown(_event){   // CodCap
+  respondToKeyDown(_event){   // CodCap override
     this.activateIde()
   }
 
@@ -1084,7 +1079,7 @@ export class IdeRunner extends IdeRunnerLogic {
   }
 
 
-  upload(){           // CodCap
+  upload(){           // CodCap override
     uploader( txt=>{
       this.applyCodeToEditorAndSave(txt)
       this.makeDirty()
@@ -1094,7 +1089,7 @@ export class IdeRunner extends IdeRunnerLogic {
 
   /**Download the current content of the editor to the download folder of the user.
    * */
-  download(content=null){   LOGGER_CONFIG.ACTIVATE && jsLogger("[Download]")    // CodCap
+  download(content=null){   LOGGER_CONFIG.ACTIVATE && jsLogger("[Download]")    // CodCap override
 
     let ideContent = content ?? this.getCodeToTest() + "" // enforce stringification in any case
     downloader(ideContent, this.pyName)
@@ -1114,7 +1109,7 @@ export class IdeRunner extends IdeRunnerLogic {
    *
    * @returns; true if the user confirmed the reset.
    * */
-  restart(){                                                      // CodCap
+  restart(){
     LOGGER_CONFIG.ACTIVATE && jsLogger("[Restart]")
 
     const doReset = window.confirm(CONFIG.lang.restartConfirm.msg)
@@ -1124,8 +1119,13 @@ export class IdeRunner extends IdeRunnerLogic {
     return doReset
   }
 
-  resetElement(doFocus=true){
-    super.resetElement()    // This marks the runner as dirty
+
+  /**Actually apply the logic to reset/restart an IDE.
+   * @doFocus can be seen as "triggered by the user?", hence, when it is false, some extra
+   * steps should be avoided, like autofocus of the element.
+   * */
+  resetElement(doFocus=true){   // CodCap override: if @doFocus is true, send notifications to Capytale).
+    super.resetElement()        // This marks the runner as dirty
     // Cancel the orange box on resets (coming with this.makeDirty() in the super call)
     this.setOrangeBox(false)
     this.setStartingCode({extractFromLocalStorage: false, saveOnceApplied: false})
@@ -1137,9 +1137,9 @@ export class IdeRunner extends IdeRunnerLogic {
     $("#solution_" + this.id).addClass('py_mk_hidden')
     this.hiddenDivContent = true
     if(doFocus) this.focusEditor()
-    // clearPyodideScope()    // v4.2.0+: no scope cleaning anymore.
-    this.takesGroupPriority() // Keep this one because the method may be triggered from some code
-                              // during the tests, without clicking on the IDE
+    // clearPyodideScope()      // PMT 4.2.0+: no scope cleaning anymore.
+    this.takesGroupPriority()   // Keep this one because the method may be triggered from some code
+                                // during the tests, without clicking on the IDE
   }
 }
 

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/js-scripts/subscriptions.js

@@ -132,7 +132,7 @@ export const chaining=0     // To control imports orders when using overrides (u
     handlePmtTooltips()
 
 
-    subscribeWhenReady("QCM", function(){
+    subscribeWhenReady("QCM", function(){             // Will always update CONFIG.subscriptionDone.QCM
       if(CONFIG.CLASSES_POOL.Qcm){                    // Building qcms only if the class is defined in the page
         LOGGER_CONFIG.ACTIVATE && jsLogger('[QCM]')
         CONFIG.CLASSES_POOL.Qcm.buildQcms()
@@ -144,7 +144,7 @@ export const chaining=0     // To control imports orders when using overrides (u
     // Done _LATE_ because of chrome troubles in Capytale: subscribing after everything has been
     // set/updated will avoid useless calls/reactions to DOM mutations (IDEs & co).
     LOGGER_CONFIG.ACTIVATE && jsLogger('[MathJax] - subscribe to document$ after pyodide started')
-    subscribeWhenReady(
+    subscribeWhenReady(                               // Will always update CONFIG.subscriptionDone.MathJax
       'MathJax',
       perennialMathJaxUpdate,
       {

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/pyodide-css/0-generic.css

@@ -282,8 +282,14 @@ mais sans lien dessus */
 .tooltip.p5-btn > img { width: 24px; }
 
 
-#floating-tip { position: absolute; z-index: 10 }
-#floating-tip > span { visibility: unset; }
+#floating-tip {
+  position: absolute;
+  z-index: 10;
+}
+#floating-tip > span {
+  visibility: unset;
+  box-shadow: 2px 3px 5px var(--hover-fg-color,#555);
+}
 
 
 input#playground-url {

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyodide_mkdocs_theme/templates/pyodide-css/history.css

@@ -22,18 +22,22 @@ If not, see <https://www.gnu.org/licenses/>.
   position: absolute;
   left: 50%;
   bottom: 50%;
-  z-index: 14;   /* above bare tooltips */
+  z-index: 4;
   background: var(--main-theme);
   border-radius: 10px;
   padding: var(--hist-size);
   display: grid;
-  grid-auto-rows: 1fr;
+  /* grid-auto-rows: 1fr; */
   gap: calc(var(--hist-size) / 1.6);
   cursor: auto;
   font-size: 90%;
+  max-height: 400px;
+  width: max-content;
+  overflow-y: auto;
+  overscroll-behavior: contain;
 }
 .history-btn {
-  width: max-content;
+  width: 100%;
   padding: 2px 8px;
   cursor: pointer;
 }

{pyodide_mkdocs_theme-5.5.4 → pyodide_mkdocs_theme-5.5.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyodide-mkdocs-theme"
-version = "5.5.4"
+version = "5.5.6"
 requires-python = ">=3.9, <4.0"
 license = { text = "GPL-3.0-or-later" }
 description = "Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations"

pyodide_mkdocs_theme-5.5.4/pyodide_mkdocs_theme/__version__.py

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