PK 8TMs2J J snippets_menu_magic/__init__.py """ Snippets menu magic Let's you create menu directly from the notebook. The menu elements can be snippets of code or internal/external links """ __version__ = '0.2' from .snippets import SnippetsMenuMagic def load_ipython_extension(ipython): sm = SnippetsMenuMagic(ipython) ipython.register_magics(sm) PK nYUM7 7 snippets_menu_magic/magic.json{ "show": { "snippet": [ "%snip_show" ] }, "add": { "a snippet": { "snippet": [ "%%snip_add path", "### snippet here" ] }, "link": { "snippet": [ "%%snip_add top bookmarks ipython -link", "https://ipython.readthedocs.io/en/stable/", "# note don't call the menu with the reserved words ", "# ['snippet', 'internal-link', 'external-link', 'menu-direction', 'sub-menu-direction']" ] }, "internal_link": { "snippet": [ "%%snip_add top bookmarks -ilink", "#internal-link" ] } }, "dump": { "snippet": [ "%snip_dump #test3.json" ], "file": { "snippet": [ "%snip_dump -f test1.json" ], "path": { "snippet": [ "%snip_dump -f test1.json testone" ] } }, "Top menu": { "snippet": [ "%snip_dump -top top" ] } }, "load": { "snippet": [ "%snip_load " ], "file": { "snippet": [ "%snip_load -f bookmarks.json top/fav" ] }, "file append": { "snippet": [ "%snip_load -a -f test3.json" ] } }, "rm": { "snippet": [ "%snip_rm path" ] }, "mv": { "snippet": [ "%snip_mv top/fav top/bookmarks" ] }, "search": { "snippet": [ "s=%snip_search \"**/bar*\"" ], "string": { "snippet": [ "s=%snip_search \"**\" -f string" ] }, "subset": { "snippet": [ "sub=%snip_subset \"**\" -f etc", "with open(\"/tmp/sub.json\", 'w') as f:", " json.dump(sub, f)" ] } }, "clear": { "snippet": [ "%snip_clear" ] }, "default": { "remove": { "snippet": [ "%snip_slice_default 0 10" ] } } }PK a|RM snippets_menu_magic/menu.json{} PK RM&K@0 0 " snippets_menu_magic/nb_register.pyget_ipython().register_magics(SnippetsMenuMagic)PK UM 05 5 snippets_menu_magic/snippets.py# %load snippets_menu_magic/snippets.py from IPython.core.magic import ( Magics, magics_class, cell_magic, line_magic ) from IPython.core.magic_arguments import ( argument, magic_arguments, parse_argstring ) import os import json import dpath.util def dequote(s): """ If a string has single or double quotes around it, remove them """ if (s[0] == s[-1]) and s.startswith(("'", '"')): return s[1:-1] return s @magics_class class SnippetsMenuMagic(Magics): def __init__(self, shell=None, **kwargs): super().__init__(shell=shell, **kwargs) self._menu = {} shell.user_ns['__menu'] = self._menu self.default_menu = [] self.reserved = ('snippet', 'internal-link', 'external-link', 'menu-direction', 'sub-menu-direction') self._dump_path = os.path.join( os.path.expanduser("~"), '.jupyter', 'custom') if '__file__' in globals(): self._module_path = os.path.abspath(os.path.dirname(__file__)) else: self._module_path = os.path.join(os.path.abspath( os.getcwd()), 'snippets_menu_magic') # interactive load def dict2list(self, src_dict): dest = [] for menu, d in src_dict.items(): # print("%s -> %s"% (menu,d)) dmenu = {} dmenu.update(d) # copy all from the source dict sub_menu_ = {} for sub, v in d.items(): if sub not in self.reserved: sub_menu_[sub] = v # remove the menu that is going to be a sub-menu del dmenu[sub] if len(sub_menu_): dmenu["sub-menu"] = self.dict2list(sub_menu_) dmenu['name'] = menu dest.append(dmenu) return dest def _get_path(self, path=None): if path: try: dump = dpath.util.get(self._menu, path) except KeyError: print("Can't find", path) return None else: dump = self._menu.copy() return dump def _format_filter_results(self, results): result_keys = [] for p, r in results: # get the entire snippet not just the pertaining line result_keys.append(('/').join(p.rsplit('/')[:-1])) for r in result_keys: print("\n-> %s " % r) print(('\n').join(dpath.util.get(self._menu, r))) def _format_results(self, results): for p, r in results: if isinstance(r, dict): if not self._is_leaf_node(r): print("/%s" % p) self._format_results(r.items()) elif isinstance(r, str): print('\n' + '-' * 20) print(r) else: # is a list print('\n' + '-' * 20) print(('\n').join(r)) print('=' * 20) def _format_path(self, path): if isinstance(path, str): # print("->", path) return dequote(path) else: # print("[]>", path) path = [dequote(menu) for menu in path] if len(path) == 1: path = path[0] return path def _dump(self, path=None): pre = ''' requirejs(["nbextensions/snippets_menu/main"], function (snippets_menu) { console.log('Loading `snippets_menu` customizations from `custom.js`'); ''' + ('\n ').join(self.default_menu) + ''' snippets_menu.options['menus'] = snippets_menu.default_menus; var horizontal_line = '---'; snippets_menu.options['menus'][0]['sub-menu'].push(horizontal_line); ''' # To-do: add the option to remove the default menu completely post = ''' }); ''' fpath = os.path.join(self._dump_path, 'custom.js') dump = self._get_path(path) if not dump: return if 'top' in dump: top = dump['top'] del dump['top'] _have_top = True else: _have_top = False # print("Writing ", fpath) with open(fpath, 'w') as file: file.write(pre) if _have_top: # insert as a top menu for m in self.dict2list(top): file.write(" snippets_menu.options['menus'].push(%s);\n" % m) for m in self.dict2list(dump): # insert as a normal submenu of Snippets file.write(" snippets_menu.options['menus'][0]['sub-menu'].push(%s);\n" % m) file.write(post) def _dump_json(self, path=None, fname='menu.json', debug=False): fpath = os.path.join(self._dump_path, fname) dump = self._get_path(path) if not dump: return print("writting ", fname) with open(fpath, 'w') as file: if not debug: json.dump(dump, file, indent=4) else: json.dump(self.dict2list(dump), file, indent=4) def _load_json(self, path=None, fname='menu.json', append=False): with open(fname) as file: if append: dpath.util.merge(self._menu, json.load( file), flags=dpath.util.MERGE_REPLACE) # self._menu.update(json.load(file)) elif path: dpath.util.new(self._menu, path, json.load(file)) else: self._menu = json.load(file) @line_magic @magic_arguments() @argument('-f', '--file', help='file.json to load the menu from', default='menu.json', nargs='?') @argument('path', help='path glob of the destination menu', nargs='?') @argument('-a', help='append to the current menu without changing existing values', default=False, action='store_true') def snip_load(self, line): ''' Load the menu from json ''' args = parse_argstring(self.snip_load, line) path = self._format_path(args.path) if args.path else None if args.file: for p in [os.path.join(self._dump_path, args.file), os.path.join(self._module_path, args.file)]: if os.path.exists(p): self._load_json(path=path, fname=p, append=args.a) return return "File not found %s" % args.file self._load_json(path=path, fname=os.path.join( self._module_path, 'menu.json'), append=args.a) @line_magic @magic_arguments() @argument('-f', '--file', help='file.json to dump the menu to', default='menu.json', nargs='?') @argument('path', help='path glob of the source menu', nargs='?') def snip_dump(self, line): ''' Dump the menu to custom.js and to menu.json (if file is not provided) ''' args = parse_argstring(self.snip_dump, line) path = self._format_path(args.path) if args.path else None self._dump(path=path) if args.file: fname = args.file[0] if isinstance(args.file, list) else args.file self._dump_json(path=path, fname=fname) else: self._dump_json(path=path) @cell_magic @magic_arguments() @argument('path', help='path glob of the menu', nargs='+') @argument('-ilink', '--internal-link', help='add an internal link instead of a snippet', default=False, action='store_true') @argument('-link', '--external-link', help='add an external link instead of a snippet', default=False, action='store_true') @argument('--menu-direction', help='define the direction of the menu CURRENTLY NOT WORKING', default=False, action='store_true') @argument('--sub-menu-direction', help='define the direction of the sub-menu CURRENTLY NOT WORKING', default=False, action='store_true') def snip_add(self, line, cell): """ inset a new menu in the tree The path must be a unique path rappresenting the menu tree structure The path will replace eventually preexisting nodes and will create all the intermidiate node (like mkdir -p) The path can be a list of separate words like %snip_add test_menu "sub menu" "dive deep" or with a path like syntax %snip_add test_menu/sub_menu/"dive deep" """ args = parse_argstring(self.snip_add, line) # print(args) path = self._format_path(args.path) if args.path else None for r in self.reserved: if r in path: raise Exception( "Can't use %s because it is a reserved keyword" % r) content = cell.split('\n') if args.internal_link: new = {'internal-link': content[0]} elif args.external_link: new = {'external-link': content[0]} elif args.menu_direction: new = {'menu-direction': content[0]} elif args.sub_menu_direction: new = {'sub-menu-direction': content[0]} else: new = {"snippet": content} dpath.util.new(self._menu, path, new) self._dump() # self._dump_json() @line_magic def snip_load_test(self, line): self._load_json(fname='test3.json', append=False) @line_magic def snip_clear(self, line): """ remove all """ self._menu = {} def _printJson(self, dict_): print(json.dumps(dict_, indent=4)) @line_magic def snip_show(self, line): """ show all """ self._printJson(self._menu) @line_magic def snip_show_custom(self): """show custom.js """ fpath = os.path.join(self._dump_path, 'custom.js') with open(fpath) as file: data = file.read() print(data) @line_magic def snip_slice_default(self, line): start, times = line.split() splice = "snippets_menu.default_menus[0]['sub-menu'].splice(%s, %s);" % ( start, times) self.default_menu.append(splice) self._dump() @line_magic @magic_arguments() @argument('path', help='path glob of the menu', nargs='+') def snip_rm(self, line): """ remove the menu that match the given glob """ args = parse_argstring(self.snip_rm, line) path = self._format_path(args.path) if args.path else None try: rows = dpath.util.delete(self._menu, path) print("deleted ", rows) except dpath.exceptions.PathNotFound as e: print("Path not found \n%s" % e) return self._dump() # self._dump_json() @line_magic @magic_arguments() @argument('src', help='source menu path', nargs='+') @argument('dst', help='destination menu path', nargs='+') def snip_mv(self, line): """ %snip_mv src_path dest_path rename/move a menu with the given path to a new path """ args = parse_argstring(self.snip_mv, line) src_path = self._format_path(args.src) if args.src else None dst_path = self._format_path(args.dst) if args.dst else None try: for src_ in dpath.util.values(self._menu, src_path): dpath.util.new(self._menu, dst_path, src_) dpath.util.delete(self._menu, src_path) except dpath.exceptions.PathNotFound as e: print("Path not found \n%s" % e) return self._dump() # self._dump_json() @line_magic @magic_arguments() @argument('path', help='path glob of the menu', nargs='?') def snip_get(self, line): ''' return the value for the menu matching the given glob ''' args = parse_argstring(self.snip_get, line) path = self._format_path(args.path) if args.path else None return dpath.util.get(self._menu, path) @line_magic @magic_arguments() @argument('path', help='path glob of the menu', nargs='+') @argument('-f', '--filter', help='filter the result containing this string', nargs='?') def snip_subset(self, line): """ returns a menu subset with the given path glob and string filter """ args = parse_argstring(self.snip_subset, line) path = self._format_path(args.path) if args.path else None if args.filter: print("Filter: %s" % args.filter) results = dpath.util.search( self._menu, path, afilter=lambda x: args.filter in str(x)) else: results = dpath.util.search(self._menu, path) return results def _is_leaf_node(self, dict_): for k in dict_.keys(): if k in self.reserved: return False return True @line_magic @magic_arguments() @argument('path', help='%snip_search "a/b/[cd]"', nargs='+') @argument('-f', '--filter', help='filter the result containing this string', nargs='?') def snip_search(self, line): """ search the menu content with the given path glob and string filter. returns a generator with the results and print out """ args = parse_argstring(self.snip_search, line) path = self._format_path(args.path) if args.path else None if args.filter: print("Filter: %s" % args.filter) results = list(dpath.util.search(self._menu, path, yielded=True, afilter=lambda x: args.filter in str(x))) self._format_filter_results(results) else: results = list(dpath.util.search(self._menu, path, yielded=True)) self._format_results(results) return results # get_ipython().register_magics(SnippetsMenuMagic) def load_ipython_extension(ipython): sm = SnippetsMenuMagic(ipython) ipython.register_magics(sm) PK QM]{], ], ) snippets_menu_magic-0.2.dist-info/LICENSE Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. PK !Hd BU c ' snippets_menu_magic-0.2.dist-info/WHEELHM K-*ϳR03rOK-J,/RH,rzd&Y)r$[)T&UD" PK !HN6K A * snippets_menu_magic-0.2.dist-info/METADATAVMs6W줓i1m/qM4rڃ'ɕ 4#Ò*5=RHan0B+kR8߈[Ya ިfQɕ3u|&MUIIa> !AF\2ڧIRl8UR('+DTrѵx?o{ܴ>UoBi s1mR zzRyGXI)ܩGˊDUb]XЄ~S_BBqj\V`ӦPhr4K|DmkJW)5cfw]{!j^0}$=e^"2~\TʬZUC罽'~aok~:T2'BcF/~ύrKC:VcSޜ&CʥI0?ůe(iM#?'S5(n+MW(;s#ĸwvAyfL?