Skip to content

added custom config dir argument #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added custom config dir argument #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 21 additions & 20 deletions src/jupyter_contrib_core/notebook_compat/_compat/nbextensions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,8 @@ def install_nbextension_python(module, overwrite=False, symlink=False,


def uninstall_nbextension(dest, require=None, user=False, sys_prefix=False,
prefix=None, nbextensions_dir=None, logger=None):
prefix=None, nbextensions_dir=None, logger=None,
config_dir=None):
"""Uninstall a Javascript extension of the notebook."""
nbext = _get_nbextension_dir(user=user, sys_prefix=sys_prefix,
prefix=prefix,
Expand All @@ -204,17 +205,17 @@ def uninstall_nbextension(dest, require=None, user=False, sys_prefix=False,

# Look through all of the config sections making sure that the nbextension
# doesn't exist.
config_dir = os.path.join(
_get_config_dir(user=user, sys_prefix=sys_prefix), 'nbconfig')
cm = BaseJSONConfigManager(config_dir=config_dir)
if not config_dir:
config_dir = _get_config_dir(user=user, sys_prefix=sys_prefix),
cm = BaseJSONConfigManager(config_dir=os.path.join(config_dir, 'nbconfig'))
if require:
for section in NBCONFIG_SECTIONS:
cm.update(section, {"load_extensions": {require: None}})


def uninstall_nbextension_python(module, user=False, sys_prefix=False,
prefix=None, nbextensions_dir=None,
logger=None):
logger=None, config_dir=None):
"""Uninstall an nbextension bundled in a Python package."""
m, nbexts = _get_nbextension_metadata(module)
for nbext in nbexts:
Expand All @@ -224,16 +225,16 @@ def uninstall_nbextension_python(module, user=False, sys_prefix=False,
logger.info("Uninstalling {} {}".format(dest, require))
uninstall_nbextension(dest, require, user=user, sys_prefix=sys_prefix,
prefix=prefix, nbextensions_dir=nbextensions_dir,
logger=logger)
logger=logger, config_dir=config_dir)


def _set_nbextension_state(section, require, state,
user=True, sys_prefix=False, logger=None):
user=True, sys_prefix=False, logger=None, config_dir=None):
"""Set whether the section's frontend should require the nbextension."""
user = False if sys_prefix else user
config_dir = os.path.join(
_get_config_dir(user=user, sys_prefix=sys_prefix), 'nbconfig')
cm = BaseJSONConfigManager(config_dir=config_dir)
if not config_dir:
config_dir = _get_config_dir(user=user, sys_prefix=sys_prefix)
cm = BaseJSONConfigManager(config_dir=os.path.join(config_dir, 'nbconfig'))
if logger:
logger.info("{} {} extension {}...".format(
"Enabling" if state else "Disabling",
Expand All @@ -248,47 +249,47 @@ def _set_nbextension_state(section, require, state,


def _set_nbextension_state_python(state, module, user, sys_prefix,
logger=None):
logger=None, config_dir=None):
"""Enable or disable some nbextensions stored in a Python package."""
m, nbexts = _get_nbextension_metadata(module)
return [_set_nbextension_state(section=nbext["section"],
require=nbext["require"],
state=state,
user=user, sys_prefix=sys_prefix,
logger=logger)
logger=logger, config_dir=config_dir)
for nbext in nbexts]


def enable_nbextension(section, require, user=True, sys_prefix=False,
logger=None):
logger=None, config_dir=None):
"""Enable a named nbextension."""
return _set_nbextension_state(section=section, require=require,
state=True,
user=user, sys_prefix=sys_prefix,
logger=logger)
logger=logger, config_dir=config_dir)


def disable_nbextension(section, require, user=True, sys_prefix=False,
logger=None):
logger=None, config_dir=None):
"""Disable a named nbextension."""
return _set_nbextension_state(section=section, require=require,
state=False,
user=user, sys_prefix=sys_prefix,
logger=logger)
logger=logger, config_dir=config_dir)


def enable_nbextension_python(module, user=True, sys_prefix=False,
logger=None):
logger=None, config_dir=None):
"""Enable some nbextensions associated with a Python module."""
return _set_nbextension_state_python(True, module, user, sys_prefix,
logger=logger)
logger=logger, config_dir=config_dir)


def disable_nbextension_python(module, user=True, sys_prefix=False,
logger=None):
logger=None, config_dir=None):
"""Disable some nbextensions associated with a Python module."""
return _set_nbextension_state_python(False, module, user, sys_prefix,
logger=logger)
logger=logger, config_dir=config_dir)


def validate_nbextension(require, logger=None):
Expand Down
6 changes: 4 additions & 2 deletions src/jupyter_contrib_core/notebook_compat/_compat/serverextensions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ class ArgumentConflict(ValueError):


def toggle_serverextension_python(import_name, enabled=None, parent=None,
user=True, sys_prefix=False, logger=None):
user=True, sys_prefix=False, logger=None,
config_dir=None):
"""Toggle a server extension.

By default, toggles the extension in the system-wide Jupyter configuration
Expand All @@ -66,7 +67,8 @@ def toggle_serverextension_python(import_name, enabled=None, parent=None,
Logger instance to use
"""
user = False if sys_prefix else user
config_dir = _get_config_dir(user=user, sys_prefix=sys_prefix)
if not config_dir:
config_dir = _get_config_dir(user=user, sys_prefix=sys_prefix)
cm = BaseJSONConfigManager(parent=parent, config_dir=config_dir)
cfg = cm.get("jupyter_notebook_config")
server_extensions = (
Expand Down