pyodide-mkdocs-theme 5.5.3__tar.gz → 5.5.5__tar.gz

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/PKG-INFO

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

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

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/pyodide_macros/plugin/maestro_files.py

@@ -83,37 +83,61 @@ class PythonLib:
     """
 
 
-
     def __post_init__(self):
-        self.path  = Path(self.lib)
-        self.exist = self.path.is_dir()
+        self.path = Path(self.lib)      # Works with "/" on windows too
 
-        if not self.exist and self.lib != PmtCte.PY_LIBS:
-            raise PmtMacrosPyLibsError(
-                f"Python libraries used for `python_lib` must be packages but found: { self.lib }."
-                "\n(a package is a directory with at least an __init__.py file, and possibly other"
-                " files or packages)"
-            )
+        # Transform any absolute path to a relative one (should never happen, but...)
+        if self.path.is_absolute():
+            self.path = self.path.relative_to(Path.cwd())
+            self.lib = self.path.as_uri()
+
+        self.exist = self.path.exists()
+        is_py = self.path.suffix == '.py'
 
-        segments = self.path.parent.parts
-        if segments:
-            loc = Path.cwd()
-            for segment in segments:
-                loc /= segment
-                if not (loc/'__init__.py').exists():
-                    break
-            else:
+        if self.exist or is_py:
+            if is_py or self.path.is_file():
                 raise PmtMacrosPyLibsError(
-                   f"The { self.lib } python_lib is not directly at the project root directory "
-                    "so it should not be importable from the CWD at build time:\n"
-                   f"Remove the `__init__.py` file from the top level directory."
+                    f"Python libraries used for `python_libs` must be packages but { self.lib } "
+                    "is a file.\nA package is a directory with at least an __init__.py file, "
+                    "and possibly other files or directories."
                 )
 
+            has_init = (self.path / '__init__.py').is_file()
+            if not has_init:
+                raise PmtMacrosPyLibsError(
+                    f"The { self.lib } directory is declared as python_lib, but it does not "
+                    "contain a __init__.py file. Only packages are usable as python libs."
+                )
+
+            is_top_level = not self.path.parent.parts
+            if not is_top_level and self._is_importable():
+                raise PmtMacrosPyLibsError(
+                    f"The `{ self.lib }` python_lib is not directly at the project root directory "
+                    "so it should not be importable from the CWD at build time. Remove an "
+                    "`__init__.py` file from one of the upper level directories."
+                )
+
+        elif self.lib != PmtCte.PY_LIBS:
+            raise PmtMacrosPyLibsError(
+                f"{ self.lib } is registered as python_lib in the mkdocs configuration file, but "
+                "the package could not be found in the project."
+            )
+
         self.lib_name  = self.path.name
         self.archive   = Path(f"{ self.lib_name }.{ PmtCte.ZIP_EXTENSION }")
         self.abs_slash = f"{ self.path.resolve().as_posix() }/"
 
 
+    def _is_importable(self):
+        upper_dirs = self.path.parent.parts
+        loc = Path.cwd()
+        for segment in upper_dirs:
+            loc /= segment
+            if not (loc/'__init__.py').exists():
+                return False
+        return True
+
+
     def __bool__(self):
         return self.exist
 
@@ -318,7 +342,7 @@ class MaestroPyLibs(MaestroGeneratedPages):
         )
         if parenting:
             raise PmtMacrosPyLibsError(
-                "Custom python libs defined in the project cannot contain others:" + parenting
+                "`python_libs` cannot contain other `python_libs`:" + parenting
             )
 
 

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/pyodide_macros/plugin_config/definitions/sub_configs.py

@@ -31,6 +31,7 @@ from ...tools_and_constants import (
     HashPathMode,
     MultiProjectFeedbackLevel,
     PageInclusion,
+    PmtCte,
     SequentialFilter,
     SequentialRun,
     NamedTestCase,
@@ -274,15 +275,15 @@ BUILD_CONFIG = SubConfigSrc(
     ),
 
     ConfigOptionSrc(
-        'python_libs', List[str], conf_type=C.ListOfItems(C.Type(str), default=['py_libs']),
-        extra_docs="""
+        'python_libs', List[str], conf_type=C.ListOfItems(C.Type(str), default=[PmtCte.PY_LIBS]),
+        extra_docs = f"""
             Liste de répertoires de [bibliothèques python](--custom-libs) qui doivent être
             importables dans Pyodide.
 
             Une erreur est levée si :
 
             * Le nom donné ne correspond pas à un répertoire existant (sauf s'il s'agit de la
-            valeur par défaut, `#!py "py_libs"`).
+            valeur par défaut, `#!py "{ PmtCte.PY_LIBS }"`).
             * Le répertoire n'est pas situé à la racine du projet.
             * Le répertoire n'est pas une bibliothèque Python (c'est-à-dire qu'il ne contient
             pas de fichier `__init__.py`).

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/pyodide_macros/tools_and_constants.py

@@ -102,7 +102,7 @@ class PmtCte:
 
     JS_CONFIG_TEMPLATES = Path(__file__).parent.parent / 'templates' / 'js-libs' / '0-config.js'
 
-    PY_LIBS = 'py_libs' # If you change this, don't forget to update config.build.python_libs default
+    PY_LIBS = 'py_libs'
     """ Default name for python libraries """
 
     LZW_DELIMITER = "\x1e"    # Unambiguous separator

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/templates/js-libs/functoolsUi.js

@@ -253,6 +253,10 @@ export const aceEditorsDayNightReactivity=()=>{
 */
 
 
+export const resetFloatingTip=()=>{
+  $("#floating-tip").css({display: 'none', width: "unset"}).find("span.tooltiptext").text("")
+}
+
 
 
 /**Logistic for PMT "bare tooltips": They are automatically put in place when an element holds at
@@ -348,14 +352,29 @@ export const handlePmtTooltips=()=>{
     })
   }
 
+  const validTags = '<br> <kbd> <code> <i> <u> <b>'.split(' ')
+
+  const getValidHtml=(html)=>{
+    // In admonitions, tags are escaped somehow (dunno where exactly), so restore them,
+    // if they are allowed:
+    html = html.replace(/\\</g, "<")
+
+    const tags = [...html.replace(/\//g,"").match(/<[^>]*>/g)||[]]
+    const tagsOk = tags.every(s=>validTags.includes(s))
+    return tagsOk ? html :  "<i>(Invalid html code)</i>"
+  }
+
 
   // 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'})
+    floating.css({display: 'none', width: "unset"})
     tipSpan.text("")
 
   }).on('mouseenter', function(e){
+    if(this.dataset.tipFloat){
+      floating.css({width: this.dataset.tipFloat+"em"})
+    }
     let pos
 
     if(this.dataset.tipMove!==undefined){
@@ -370,7 +389,8 @@ export const handlePmtTooltips=()=>{
 
       pos = getAnchorPoint(rect, pagePos, this)
     }
-    tipSpan.html(this.dataset.tipTxt)
+    const content = getValidHtml(this.dataset.tipTxt)
+    tipSpan.html(content)
     placement(pos)
   }).addClass('tip-done')
 

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/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.
@@ -51,7 +53,8 @@ const defaultOptions=(options, prop)=>({
     shift: 50,          // %
     tipWidth: 0,        // em ; 0 => auto
     tipClass: '',       // top bottom left right (default: bottom)
-    tipBare: false,     // If true, use the "bare tooltips" mechanism
+    bareTip: false,     // If true, use the "bare tooltips" mechanism
+    floatingWidth: 0,
 
     autoCbk: true,      // If true, automatic event routine added
     disabled: undefined,
@@ -93,9 +96,10 @@ const stuffWithTooltip = (tag, options, content) =>{
     const tagId    = !options.tagId   ? '':`id="${ options.tagId }"`
     const tagStyle = getTagStyle(options)
     const tipSpan  = buildTipSpan(options)
-    const tagDataTip = !options.bareTip || !options.tipText ? '' : ` data-tip-txt="${ options.tipText }"`+(
-        !options.tipWidth ? '' : `data-tip-width="${ options.tipWidth }"`
-    )
+    const tagDataTip = !(options.bareTip && options.tipText) ? ''
+                            : ` data-tip-txt="${ options.tipText }"`
+                            + (!options.tipWidth ? '' : `data-tip-width="${ options.tipWidth }"`)
+                            + (!options.floatingWidth ? '' : `data-tip-float="${ options.floatingWidth }"`)
 
     const buttonType = ' type="button"'.repeat(tag=='button')
     return $([
@@ -259,6 +263,8 @@ 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...

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/templates/js-per-pages/4-ideRunner-ide.js

@@ -219,7 +219,7 @@ class IdeHistoryManager extends IdeAceManager {
   }
 
 
-  setupHistoryBtn(jHistItem, [done, time, code]){
+  setupHistoryItem(jHistItem, [done, time, code]){
     jHistItem.text(time)
     jHistItem.on('click', e=>{
       cancelEvent(e)
@@ -953,7 +953,7 @@ export class IdeRunner extends IdeRunnerLogic {
                             btn,
                             `history_${ ideThis.id }`,
                             ideThis.validations,
-                            ideThis.setupHistoryBtn.bind(ideThis),
+                            ideThis.setupHistoryItem.bind(ideThis),
                           )
                           callback = ideThis.runners.validate.asEvent ; break
 

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/templates/js-scripts/subscriptions.js

@@ -88,7 +88,7 @@ export const chaining=0     // To control imports orders when using overrides (u
     LOGGER_CONFIG.ACTIVATE && jsLogger('[Subscriptions] - Done waiting: starting subscriptions')
 
     const managerClass = CONFIG.CLASSES_POOL.GlobalRunnersManager
-    const isPageWithRunners = Boolean(managerClass)
+    const isPageWithRunners = "Wait4StartPyodide" in CONFIG.subscriptionReady
     if(isPageWithRunners){
 
       managerClass._defineIdesManagerProxyLikeAndStore_MANAGER_InConfig()

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/templates/pyodide-css/0-generic.css

@@ -282,7 +282,7 @@ mais sans lien dessus */
 .tooltip.p5-btn > img { width: 24px; }
 
 
-#floating-tip { position: absolute; z-index: 1 }
+#floating-tip { position: absolute; z-index: 10 }
 #floating-tip > span { visibility: unset; }
 
 

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyodide_mkdocs_theme/templates/pyodide-css/history.css

@@ -22,7 +22,7 @@ If not, see <https://www.gnu.org/licenses/>.
   position: absolute;
   left: 50%;
   bottom: 50%;
-  z-index: 4;   /* above bare tooltips */
+  z-index: 4;
   background: var(--main-theme);
   border-radius: 10px;
   padding: var(--hist-size);

{pyodide_mkdocs_theme-5.5.3 → pyodide_mkdocs_theme-5.5.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyodide-mkdocs-theme"
-version = "5.5.3"
+version = "5.5.5"
 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.3/pyodide_mkdocs_theme/__version__.py

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