9194320800

Committed 22 May 2024 03:37PM UTC coverage: 31.551%. Remained the same

Build # 9194320800

Build Type

push

github

Committed by

web-flow

Commit Message

Update `debug.py` to run with `IPython >= 8`. (#13)

Also requiring at least that version of IPython.

Run Details

9 of 39 branches covered (23.08%)

Branch coverage included in aggregate %.

0 of 4 new or added lines in 1 file covered. (0.0%)

1 existing line in 1 file now uncovered.

50 of 148 relevant lines covered (33.78%)

0.34 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/grokcore/startup/debug.py

##############################################################################
#
# Copyright (c) 2006-2012 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
import os.path
import textwrap
from pprint import pprint

import transaction
import zope.app.debug
import zope.app.wsgi
from IPython.terminal.embed import InteractiveShellEmbed
from zope.component import getMultiAdapter
from zope.component import getUtility
from zope.securitypolicy.zopepolicy import settingsForObject


shell = InteractiveShellEmbed()

PATH_SEP = '/'


class GrokDebug:

    def __init__(self, debugger):
        debugger = debugger
        self.app = debugger
        self.root = debugger.root()
        self.context = self.root

    def get_start_context(self, path):
        if path.startswith(PATH_SEP):
            context = self.root
        else:
            # relative path
            context = self.context
        return context

    def _get_object_names(self, context):
        return [obj.__name__ for obj in context.values()]

    def ns(self):
        """Return namespace dictionary.

        To be used for updating namespace of commands available
        for user in shell.
        """
        return dict(lsg=self.ls,
                    cdg=self.cd,
                    pwdg=self.pwd,
                    app=self.app,
                    root=self.root,
                    ctx=self.ctx,
                    sec=self.get_security_settings,
                    gu=getUtility,
                    gma=getMultiAdapter,
                    sync=self.sync,
                    pby=self.providedBy,
                    commit=transaction.commit)

    def update_ns(self):
        shell.user_ns.update(self.ns())

    def get_security_settings(self, path):
        pprint(
            settingsForObject(
                get_context_by_path(self.get_start_context(path), path)))

    def sync(self):
        self.root._p_jar.sync()

    def ls(self, path=None):
        """List objects.

        This command is bound to `lsg` in IPython shell.

        Without `path` parameter list objects in current container,
        which is available as `ctx` from IPython shell.

        `path` can be relative or absolute.

        To use autocompletion of path command should be invoked
        with prepended semicolon in ipython shell as
        ;lsg /path
        """
        if path is None:
            return self._get_object_names(self.context)

        context = get_context_by_path(self.get_start_context(path), path)
        return self._get_object_names(context)

    def cd(self, path):
        """cd to specified path.

        Bound to `cdg` in IPython shell.
        `path` can be relative or absolute.

        To use autocompletion of path command should be invoked
        with prepended semicolon in ipython shell as
        ;cdg /path
        """
        if path.strip() == '..':
            self.context = self.context.__parent__
            self.update_ns()
            return self.pwd

        # cd
        self.context = get_context_by_path(self.get_start_context(path), path)
        self.update_ns()
        return self.pwd

    @property
    def pwd(self):
        """Print absolute path to current context object.

        Bound to `pwdg` in IPython shell
        """
        res = []
        obj = self.context
        while obj is not None:
            name = obj.__name__
            if name is not None and name:
                res.append(name)
            obj = obj.__parent__

        if not res:
            return PATH_SEP

        res = PATH_SEP.join(reversed(res))
        if not res.startswith(PATH_SEP):
            return PATH_SEP + res

        return res

    @property
    def ctx(self):
        """Return current context object.

        Bound to `ctx` in IPython shell
        """
        return self.context

    def providedBy(self, obj=None):
        if not obj:
            obj = self.ctx
        return list(zope.interface.providedBy(obj))


def get_context_by_path(context, path):
    for name in (p for p in path.split(PATH_SEP) if p):
        context = context[name]
    return context


def path_completer(self, event):
    """TAB path completer for `cdg` and `lsg` commands."""
    relpath = event.symbol

    context = grokd.get_start_context(relpath)  # noqa: F821 undefined name

    # ends with '/'
    if relpath.endswith(PATH_SEP):
        context = get_context_by_path(context, relpath)
        return [relpath + obj.__name__ for obj in context.values()]

    head, tail = os.path.split(relpath)
    if head and not head.endswith(PATH_SEP):
        head += PATH_SEP
    context = get_context_by_path(context, head)

    return [
        head + obj.__name__ for obj in context.values()
        if obj.__name__.startswith(tail)
    ]


def ipython_debug_prompt(debugger):
    grokd = GrokDebug(debugger)
    banner = textwrap.dedent("""\
        IPython shell for Grok.

        Bound object names:
        -------------------
          root
          ctx

        Bound command names:
        --------------------
          cdg / ;cdg
          lsg / ;lsg
          sec / ;sec
          gu  / ;gu
          gma / ;gma
          pby (providedBy)
          pwdg
          sync
          commit
        """)

    shell.user_ns.update(grokd.ns())
    shell.banner2 = banner
    shell.set_hook('complete_command', path_completer, re_key='.*cdg|.*lsg')
    shell(local_ns=grokd.ns())

1	##############################################################################
2	#
3	# Copyright (c) 2006-2012 Zope Foundation and Contributors.
4	# All Rights Reserved.
5	#
6	# This software is subject to the provisions of the Zope Public License,
7	# Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
8	# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
9	# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
10	# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
11	# FOR A PARTICULAR PURPOSE.
12	#
13	##############################################################################
14	import os.path	×
15	import textwrap	×
16	from pprint import pprint	×
17
18	import transaction	×
19	import zope.app.debug	×
20	import zope.app.wsgi	×
NEW 21	from IPython.terminal.embed import InteractiveShellEmbed	×
22	from zope.component import getMultiAdapter	×
23	from zope.component import getUtility	×
24	from zope.securitypolicy.zopepolicy import settingsForObject	×
25
26
27	shell = InteractiveShellEmbed()	×
28
UNCOV 29	PATH_SEP = '/'	×
30
31
32	class GrokDebug:	×
33
34	def __init__(self, debugger):	×
35	debugger = debugger	×
36	self.app = debugger	×
37	self.root = debugger.root()	×
38	self.context = self.root	×
39
40	def get_start_context(self, path):	×
41	if path.startswith(PATH_SEP):	×
42	context = self.root	×
43	else:
44	# relative path
45	context = self.context	×
46	return context	×
47
48	def _get_object_names(self, context):	×
49	return [obj.__name__ for obj in context.values()]	×
50
51	def ns(self):	×
52	"""Return namespace dictionary.
53
54	To be used for updating namespace of commands available
55	for user in shell.
56	"""
57	return dict(lsg=self.ls,	×
58	cdg=self.cd,
59	pwdg=self.pwd,
60	app=self.app,
61	root=self.root,
62	ctx=self.ctx,
63	sec=self.get_security_settings,
64	gu=getUtility,
65	gma=getMultiAdapter,
66	sync=self.sync,
67	pby=self.providedBy,
68	commit=transaction.commit)
69
70	def update_ns(self):	×
71	shell.user_ns.update(self.ns())	×
72
73	def get_security_settings(self, path):	×
NEW 74	pprint(	×
75	settingsForObject(
76	get_context_by_path(self.get_start_context(path), path)))
77
78	def sync(self):	×
79	self.root._p_jar.sync()	×
80
81	def ls(self, path=None):	×
82	"""List objects.
83
84	This command is bound to `lsg` in IPython shell.
85
86	Without `path` parameter list objects in current container,
87	which is available as `ctx` from IPython shell.
88
89	`path` can be relative or absolute.
90
91	To use autocompletion of path command should be invoked
92	with prepended semicolon in ipython shell as
93	;lsg /path
94	"""
95	if path is None:	×
96	return self._get_object_names(self.context)	×
97
98	context = get_context_by_path(self.get_start_context(path), path)	×
99	return self._get_object_names(context)	×
100
101	def cd(self, path):	×
102	"""cd to specified path.
103
104	Bound to `cdg` in IPython shell.
105	`path` can be relative or absolute.
106
107	To use autocompletion of path command should be invoked
108	with prepended semicolon in ipython shell as
109	;cdg /path
110	"""
111	if path.strip() == '..':	×
112	self.context = self.context.__parent__	×
113	self.update_ns()	×
114	return self.pwd	×
115
116	# cd
117	self.context = get_context_by_path(self.get_start_context(path), path)	×
118	self.update_ns()	×
119	return self.pwd	×
120
121	@property	×
122	def pwd(self):	×
123	"""Print absolute path to current context object.
124
125	Bound to `pwdg` in IPython shell
126	"""
127	res = []	×
128	obj = self.context	×
129	while obj is not None:	×
130	name = obj.__name__	×
131	if name is not None and name:	×
132	res.append(name)	×
133	obj = obj.__parent__	×
134
135	if not res:	×
136	return PATH_SEP	×
137
138	res = PATH_SEP.join(reversed(res))	×
139	if not res.startswith(PATH_SEP):	×
140	return PATH_SEP + res	×
141
142	return res	×
143
144	@property	×
145	def ctx(self):	×
146	"""Return current context object.
147
148	Bound to `ctx` in IPython shell
149	"""
150	return self.context	×
151
152	def providedBy(self, obj=None):	×
153	if not obj:	×
154	obj = self.ctx	×
155	return list(zope.interface.providedBy(obj))	×
156
157
158	def get_context_by_path(context, path):	×
159	for name in (p for p in path.split(PATH_SEP) if p):	×
160	context = context[name]	×
161	return context	×
162
163
164	def path_completer(self, event):	×
165	"""TAB path completer for `cdg` and `lsg` commands."""
166	relpath = event.symbol	×
167
168	context = grokd.get_start_context(relpath) # noqa: F821 undefined name	×
169
170	# ends with '/'
171	if relpath.endswith(PATH_SEP):	×
172	context = get_context_by_path(context, relpath)	×
173	return [relpath + obj.__name__ for obj in context.values()]	×
174
175	head, tail = os.path.split(relpath)	×
176	if head and not head.endswith(PATH_SEP):	×
177	head += PATH_SEP	×
178	context = get_context_by_path(context, head)	×
179
NEW 180	return [	×
181	head + obj.__name__ for obj in context.values()
182	if obj.__name__.startswith(tail)
183	]
184
185
186	def ipython_debug_prompt(debugger):	×
187	grokd = GrokDebug(debugger)	×
NEW 188	banner = textwrap.dedent("""\	×
189	IPython shell for Grok.
190
191	Bound object names:
192	-------------------
193	root
194	ctx
195
196	Bound command names:
197	--------------------
198	cdg / ;cdg
199	lsg / ;lsg
200	sec / ;sec
201	gu / ;gu
202	gma / ;gma
203	pby (providedBy)
204	pwdg
205	sync
206	commit
207	""")
208
209	shell.user_ns.update(grokd.ns())	×
210	shell.banner2 = banner	×
211	shell.set_hook('complete_command', path_completer, re_key='.cdg\|.lsg')	×
212	shell(local_ns=grokd.ns())	×

zopefoundation / grokcore.startup / 9194320800

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous