Rework the devshell
v2 cover Rework the devshell
From: Chris Larson <[email protected]>
- Adds a utility metaclass for maintaining class registries
- Shifts the handling of spawning a terminal into a new 'terminal' python module
- Automatically selects an appropriate terminal based on what you have available on your machine
- Still allows manual selection, but in a more convenient way, and falls back to auto if you select an invalid or unavailable (not installed) terminal
- Improves how we spawn screen:
- Shows a warning when spawning it, so do_devshell doesn't appear to hang
- Spawns a named screen session 'devshell', to avoid confusion when the user already has other screen sessions running
Pull URL: https://github.com/kergoth/oe-core
Branch: devshell
Browse: https://github.com/kergoth/oe-core/commits/devshell
Thanks,
Chris Larson <[email protected]>
---
Chris Larson (3):
oe.classutils: add module
Rework how the devshell functions
oe.terminal: improve how we spawn screen
meta/classes/devshell.bbclass | 26 ++++------- meta/classes/terminal.bbclass | 30 +++++++++++ meta/lib/oe/classutils.py | 45 +++++++++++++++++ meta/lib/oe/terminal.py | 107 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 191 insertions(+), 17 deletions(-) create mode 100644 meta/classes/terminal.bbclass create mode 100644 meta/lib/oe/classutils.py create mode 100644 meta/lib/oe/terminal.py
Signature · 1 line
1.7.4.1
PATCH v2 1/3 oe.classutils: add module
From: Chris Larson <[email protected]>
This adds a ClassRegistry utility metaclass, as maintaining a class registry is a fairly common thing to do.
--- meta/lib/oe/classutils.py | 24 ++++++++++++++++++++++++ 1 files changed, 24 insertions(+), 0 deletions(-) create mode 100644 meta/lib/oe/classutils.py
meta/lib/oe/classutils.py new file +24 -0
@@ -0,0 +1,24 @@ +class ClassRegistry(type): + """Maintain a registry of classes, indexed by name. + + The name in the registry can be overridden via the 'name' attribute of the + class, and the 'priority' attribute controls priority. The prioritized() + method returns the registered classes in priority order.""" + registry = {} + priority = 0 + + def __init__(cls, name, bases, attrs): + super(ClassRegistry, cls).__init__(name, bases, attrs) + if not hasattr(cls, name): + cls.name = name + cls.registry[cls.name] = cls + + @classmethod + def prioritized(tcls): + return sorted(tcls.registry.values(), + key=lambda v: v.priority, reverse=True) + + def unregister(cls): + for key in cls.registry.keys(): + if cls.registry[key] is cls: + del cls.registry[key]
Signature · 1 line
1.7.4.1
PATCH v2 2/3 Rework how the devshell functions
In reply to Chris LarsonFrom: Chris Larson <[email protected]>
In the new implementation, each known terminal is defined as a class in oe.terminal, as a subclass of bb.process.Popen. terminal.bbclass wraps this functionality, providing the metadata pieces. It obeys the OE_TERMINAL variable, which is a 'choice' typed variable. This variable may be 'auto', 'none', or any of the names of the defined terminals.
When using 'auto', or requesting an unsupported terminal, we attempt to spawn them in priority order until we get one that's available on this system (and in the case of the X terminals, has DISPLAY defined). The 'none' value is used when we're doing things like automated builds, and want to ensure that no terminal is *ever* spawned, under any circumstances.
Current available terminals:
gnome
konsole
xterm
rxvt
screen
--- meta/classes/devshell.bbclass | 26 ++++------- meta/classes/terminal.bbclass | 30 ++++++++++++ meta/lib/oe/classutils.py | 33 +++++++++++-- meta/lib/oe/terminal.py | 102 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 168 insertions(+), 23 deletions(-) create mode 100644 meta/classes/terminal.bbclass create mode 100644 meta/lib/oe/terminal.py
meta/classes/devshell.bbclass +9 -17
@@ -1,22 +1,14 @@ -do_devshell[dirs] = "${S}" -do_devshell[nostamp] = "1" +inherit terminal -XAUTHORITY ?= "${HOME}/.Xauthority" -devshell_do_devshell() { - export DISPLAY='${DISPLAY}' - export DBUS_SESSION_BUS_ADDRESS='${DBUS_SESSION_BUS_ADDRESS}' - export XAUTHORITY='${XAUTHORITY}' - export TERMWINDOWTITLE="Bitbake Developer Shell" - export EXTRA_OEMAKE='${EXTRA_OEMAKE}' - export SHELLCMDS="bash" - ${TERMCMDRUN} - if [ $? -ne 0 ]; then - echo "Fatal: '${TERMCMD}' not found. Check TERMCMD variable." - exit 1 - fi +export XAUTHORITY ?= "${HOME}/.Xauthority" +export SHELL ?= 'bash' + +python do_devshell () { + oe_terminal(d.getVar('SHELL', True), 'OpenEmbedded Developer Shell', d) } -addtask devshell after do_patch -EXPORT_FUNCTIONS do_devshell +addtask devshell after do_patch +do_devshell[dirs] = "${S}" +do_devshell[nostamp] = "1"
meta/classes/terminal.bbclass new file +30 -0
@@ -0,0 +1,30 @@ +OE_TERMINAL ?= 'auto' +OE_TERMINAL[type] = 'choice' +OE_TERMINAL[choices] = 'auto none \ + ${@" ".join(o.name \ + for o in oe.terminal.prioritized())}' + + +def oe_terminal(command, title, d): + import oe.data + import oe.terminal + + terminal = oe.data.typed_value('OE_TERMINAL', d).lower() + if terminal == 'none': + bb.fatal('Devshell usage disabled with OE_TERMINAL') + elif terminal != 'auto': + try: + oe.terminal.spawn(terminal, command, title) + return + except oe.terminal.UnsupportedTerminal: + bb.warn('Unsupported terminal "%s", defaulting to "auto"' % + terminal) + except oe.terminal.ExecutionError as exc: + bb.fatal('Unable to spawn terminal %s: %s' % (terminal, exc)) + + try: + oe.terminal.spawn_preferred(command, title) + except oe.terminal.NoSupportedTerminals: + bb.fatal('No valid terminal found, unable to open devshell') + except oe.terminal.ExecutionError as exc: + bb.fatal('Unable to spawn terminal %s: %s' % (terminal, exc))
meta/lib/oe/classutils.py +27 -6
@@ -1,15 +1,36 @@ +__author__ = 'kergoth' + class ClassRegistry(type): """Maintain a registry of classes, indexed by name. - The name in the registry can be overridden via the 'name' attribute of the - class, and the 'priority' attribute controls priority. The prioritized() - method returns the registered classes in priority order.""" - registry = {} +Note that this implementation requires that the names be unique, as it uses +a dictionary to hold the classes by name. + +The name in the registry can be overridden via the 'name' attribute of the +class, and the 'priority' attribute controls priority. The prioritized() +method returns the registered classes in priority order. + +Subclasses of ClassRegistry may define an 'implemented' property to exert +control over whether the class will be added to the registry (e.g. to keep +abstract base classes out of the registry).""" priority = 0 + class __metaclass__(type): + """Give each ClassRegistry their own registry""" + def __init__(cls, name, bases, attrs): + cls.registry = {} + type.__init__(cls, name, bases, attrs) def __init__(cls, name, bases, attrs): super(ClassRegistry, cls).__init__(name, bases, attrs) - if not hasattr(cls, name): + try: + if not cls.implemented: + return + except AttributeError: + pass + + try: + cls.name + except AttributeError: cls.name = name cls.registry[cls.name] = cls
@@ -21,4 +42,4 @@ class ClassRegistry(type): def unregister(cls): for key in cls.registry.keys(): if cls.registry[key] is cls: - del cls.registry[key] + del cls.registry[key]
meta/lib/oe/terminal.py new file +102 -0
102 lines not on this page · raw message
Signature · 1 line
1.7.4.1
PATCH v2 3/3 oe.terminal: improve how we spawn screen
In reply to Chris LarsonFrom: Chris Larson <[email protected]>
- Name the screen session 'devshell', to avoid confusion if running bitbake itself under a screen session.
- Display a warning message when spawning screen, so it's clear to the user that screen has been run (otherwise do_devshell just appears to hang).
--- meta/lib/oe/terminal.py | 7 ++++++- 1 files changed, 6 insertions(+), 1 deletions(-)
meta/lib/oe/terminal.py +6 -1
@@ -71,7 +71,12 @@ class Rxvt(XTerminal): priority = 1 class Screen(Terminal): - command = 'screen -D -m -t "{title}" {command}' + command = 'screen -D -m -t "{title}" -S devshell {command}' + + def __init__(self, command, title=None): + Terminal.__init__(self, command, title) + logger.warn('Screen started. Please connect in another terminal with ' + '"screen -r devshell"') def prioritized():
Signature · 1 line
1.7.4.1
Quoted 11 lines · Chris Larson
From: Chris Larson<[email protected]>
- Adds a utility metaclass for maintaining class registries
- Shifts the handling of spawning a terminal into a new 'terminal' python module
- Automatically selects an appropriate terminal based on what you have available on your machine
- Still allows manual selection, but in a more convenient way, and falls back to auto if you select an invalid or unavailable (not installed) terminal
- Improves how we spawn screen:
Quoted 4 lines
- Shows a warning when spawning it, so
do_devshelldoesn't appear to hang
- Spawns a named screen session 'devshell', to avoid confusion when the user already has other screen sessions running
works nicely. I usually use screen and it helped
Quoted 23 lines
Pull URL: https://github.com/kergoth/oe-core
Branch: devshell
Browse: https://github.com/kergoth/oe-core/commits/devshellThanks,
Chris Larson<[email protected]>
---Chris Larson (3):
oe.classutils: add module
Rework how the devshell functions
oe.terminal: improve how we spawn screenmeta/classes/devshell.bbclass | 26 ++++------- meta/classes/terminal.bbclass | 30 +++++++++++ meta/lib/oe/classutils.py | 45 +++++++++++++++++ meta/lib/oe/terminal.py | 107 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 191 insertions(+), 17 deletions(-)create mode 100644 meta/classes/terminal.bbclass create mode 100644
meta/lib/oe/classutils.pycreate mode 100644meta/lib/oe/terminal.py