[python] 파이썬에서 최소 플러그인 아키텍처 구축

필자는 상당히 기술적 인 청중 (과학자)이 사용하는 Python으로 작성된 응용 프로그램을 가지고 있습니다.

사용자가 응용 프로그램을 확장 가능하게 만드는 좋은 방법, 즉 스크립팅 / 플러그인 아키텍처를 찾고 있습니다.

나는 매우 가벼운 것을 찾고 있습니다. 대부분의 스크립트 또는 플러그인은 타사에서 개발 및 배포하지 않고 몇 분 안에 사용자가 반복 작업을 자동화하고 파일 형식에 대한 지원을 추가하기 위해 채찍질 할 것입니다. 따라서 플러그인에는 절대 최소 상용구 코드가 있어야하며 폴더에 복사하는 것 외에 ‘설치’가 필요하지 않습니다 (따라서 setuptools 진입 점 또는 Zope 플러그인 아키텍처와 같은 것).

이와 같은 시스템이 이미 있거나 아이디어 / 영감을 살펴 봐야하는 유사한 체계를 구현하는 프로젝트가 있습니까?



답변

Mine은 기본적으로 “plugins”라는 디렉토리로, 메인 앱이 폴링 한 다음 imp.load_module 을 사용 하여 파일을 픽업하고, 모듈 수준 구성 매개 변수를 사용하여 잘 알려진 진입 점을 찾은 다음 거기서 갈 수있는 디렉토리 입니다. 플러그인이 활성화 된 특정 양의 역 동성을 위해 파일 모니터링 기능을 사용하지만 사용하기 편리합니다.

물론, “[복잡한 것 X은 필요하지 않습니다. 단지 가벼운 것을 원합니다.”라고 말하는 모든 요구 사항은 한 번에 하나의 발견 된 요구 사항을 다시 구현할 위험이 있습니다. 그러나 그것은 당신이 어쨌든 재미있는 일을 할 수 없다고 말하는 것은 아닙니다 🙂


답변

module_example.py:

def plugin_main(*args, **kwargs):
    print args, kwargs

loader.py:

def load_plugin(name):
    mod = __import__("module_%s" % name)
    return mod

def call_plugin(name, *args, **kwargs):
    plugin = load_plugin(name)
    plugin.plugin_main(*args, **kwargs)

call_plugin("example", 1234)

확실히 “최소”이며, 오류 검사가 전혀 없으며, 수많은 보안 문제가있을 수 있으며, 매우 유연하지는 않습니다. 그러나 파이썬의 플러그인 시스템이 얼마나 간단한 지 보여줍니다 ..

당신은 아마 보길 원하는 꼬마 도깨비 당신이 단지와 많이 할 수 있지만, 너무 모듈 __import__, os.listdir일부 문자열 조작을.


답변

기존 플러그인 프레임 워크 / 라이브러리에 대한이 개요를 살펴보면 좋은 출발점이됩니다. 나는 yapsy를 매우 좋아 하지만 사용 사례에 달려 있습니다.


답변

그 질문은 정말 흥미롭지 만 자세한 내용은 대답하기가 상당히 어렵다고 생각합니다. 어떤 종류의 응용입니까? GUI가 있습니까? 명령 줄 도구입니까? 스크립트 세트? 독특한 진입 점 등을 가진 프로그램 …

내가 가진 작은 정보를 감안할 때, 나는 매우 일반적인 방식으로 답변 할 것입니다.

플러그인을 추가해야하는 것은 무엇입니까?

  • 로드 할 경로 / 디렉토리를 나열하는 구성 파일을 추가해야합니다.
  • 또 다른 방법은 “그 플러그인 / 디렉토리의 모든 파일이로드됩니다”라고 말하지만 사용자가 파일을 이동해야하는 불편 함이 있습니다.
  • 마지막으로 중간 옵션은 모든 플러그인이 동일한 plugin / 폴더에 있어야하고 구성 파일의 상대 경로를 사용하여 활성화 / 비활성화하는 것입니다.

순수한 코드 / 디자인 실습에서는 사용자가 확장하려는 행동 / 특정 작업을 명확하게 결정해야합니다. 항상 대체 될 공통 진입 점 / 기능 세트를 식별하고 이러한 조치 내의 그룹을 결정하십시오. 이 작업이 완료되면 응용 프로그램을 쉽게 확장 할 수 있어야합니다.

MediaWiki에서 영감을 얻은 hooks 사용 예제 (PHP이지만 언어는 실제로 중요합니까?) :

import hooks

# In your core code, on key points, you allow user to run actions:
def compute(...):
    try:
        hooks.runHook(hooks.registered.beforeCompute)
    except hooks.hookException:
        print('Error while executing plugin')

    # [compute main code] ...

    try:
        hooks.runHook(hooks.registered.afterCompute)
    except hooks.hookException:
        print('Error while executing plugin')

# The idea is to insert possibilities for users to extend the behavior 
# where it matters.
# If you need to, pass context parameters to runHook. Remember that
# runHook can be defined as a runHook(*args, **kwargs) function, not
# requiring you to define a common interface for *all* hooks. Quite flexible :)

# --------------------

# And in the plugin code:
# [...] plugin magic
def doStuff():
    # ....
# and register the functionalities in hooks

# doStuff will be called at the end of each core.compute() call
hooks.registered.afterCompute.append(doStuff)

수은에서 영감을 얻은 또 다른 예. 여기서 확장은 hg 명령 줄 실행 파일 에만 명령을 추가 하여 동작을 확장합니다.

def doStuff(ui, repo, *args, **kwargs):
    # when called, a extension function always receives:
    # * an ui object (user interface, prints, warnings, etc)
    # * a repository object (main object from which most operations are doable)
    # * command-line arguments that were not used by the core program

    doMoreMagicStuff()
    obj = maybeCreateSomeObjects()

# each extension defines a commands dictionary in the main extension file
commands = { 'newcommand': doStuff }

두 가지 방법 모두 확장에 대한 공통 초기화마무리 가 필요할 수 있습니다 . 모든 확장이 구현해야하는 공통 인터페이스를 사용하거나 (두 번째 접근 방식에 더 적합합니다. 머큐리얼은 모든 확장에 대해 호출되는 reposetup (ui, repo)를 사용합니다) 또는 hooks.setup 후크.

그러나 더 유용한 답변을 원한다면 질문 범위를 좁혀 야합니다.)


답변

Marty Allchin의 간단한 플러그인 프레임 워크 는 내가 필요로하는 기반입니다. 나는 그것을 보라고 정말로 권합니다. 단순하고 쉽게 해킹 할 수있는 것을 원한다면 정말 좋은 시작이라고 생각합니다. Django Snippets 로도 찾을 수 있습니다 .


답변

저는 디지털 마이크로 그래프를 다루고 SGi 머신에서 실행하기 위해 이미지 처리 및 분석 패키지 (기술적으로 라이브러리가 아님)를 작성해야하는 은퇴 한 생물 학자입니다. C로 코드를 작성하고 스크립팅 언어로 Tcl을 사용했습니다. GUI는 Tk를 사용하여 수행되었습니다. Tcl에 나타난 명령은 “extensionName commandName arg0 arg1 … param0 param1 …”형식, 즉 공백으로 구분 된 간단한 단어와 숫자입니다. Tcl이 “extensionName”하위 문자열을 보았을 때 제어는 C 패키지로 전달되었습니다. 그런 다음 lexer / parser (lex / yacc에서 수행)를 통해 명령을 실행 한 다음 필요에 따라 C 루틴을 호출했습니다.

패키지를 조작하는 명령은 GUI의 창을 통해 하나씩 실행될 수 있지만 배치 작업은 유효한 Tcl 스크립트 인 텍스트 파일을 편집하여 수행되었습니다. 원하는 파일 수준 작업을 수행 한 템플릿을 선택한 다음 실제 디렉토리 및 파일 이름과 패키지 명령을 포함하도록 복사본을 편집합니다. 그것은 매력처럼 작동했습니다. …까지

1) 세계는 PC로 바뀌었고 2) Tcl의 iffy 조직 구성 기능이 실제로 불편 해지기 시작했을 때 스크립트는 약 500 줄을 넘었습니다. 시간이 지났다 …

나는 은퇴했고, 파이썬은 발명되었고, Tcl의 완벽한 후계자처럼 보였다. PC에서 C 프로그램을 컴파일하고 C 패키지로 Python을 확장하며 Python / Gt? / Tk? /?에서 GUI를 수행하는 문제에 직면 한 적이 없기 때문에 이제는 포트를 한 적이 없습니다. ?. 그러나 편집 가능한 템플릿 스크립트를 사용한다는 오래된 아이디어는 여전히 실행 가능한 것으로 보입니다. 또한 다음과 같이 네이티브 파이썬 형식으로 패키지 명령을 입력하는 것이 너무 큰 부담이되어서는 안됩니다.

packageName.command (arg0, arg1, …, param0, param1, …)

몇 가지 추가 점, 괄호 및 쉼표가 있지만 표시되지 않습니다.

누군가 파이썬에서 lex 및 yacc 버전을 수행 한 것을 본 기억이 있습니다 ( http://www.dabeaz.com/ply/ ). 그래도 필요한 경우 주변에 있습니다.

이 혼란의 요점은 파이썬 자체가 과학자들이 사용할 수있는 원하는 “경량”프론트 엔드 인 것 같습니다. 왜 그렇지 않다고 생각하는지 궁금합니다. 진심입니다.


나중에 추가 : 응용 프로그램 gedit 은 플러그인이 추가 될 것으로 예상하며 해당 사이트에는 몇 분 동안 둘러 본 간단한 플러그인 절차에 대한 가장 명확한 설명이 있습니다. 시험:

https://wiki.gnome.org/Apps/Gedit/PythonPluginHowToOld

여전히 귀하의 질문을 더 잘 이해하고 싶습니다. 1) 과학자가 (Python) 응용 프로그램을 다양한 방식으로 매우 간단하게 사용할 수 있기를 원하는지 또는 2) 과학자가 응용 프로그램에 새로운 기능을 추가 할 수 있는지 여부는 확실하지 않습니다. 선택 # 1은 이미지에 직면 한 상황으로, 현재의 필요에 맞게 수정 된 일반 스크립트를 사용하게되었습니다. 플러그인 아이디어로 연결되는 선택 # 2입니까, 아니면 명령을 실행하는 것이 불가능한 응용 프로그램의 일부입니까?


답변

Python Decorators를 검색 할 때 간단하지만 유용한 코드 스 니펫을 찾았습니다. 그것은 당신의 필요에 맞지 않지만 매우 고무적 일 수 있습니다.

Scipy 고급 Python # Plugin 등록 시스템

class TextProcessor(object):
    PLUGINS = []

    def process(self, text, plugins=()):
        if plugins is ():
            for plugin in self.PLUGINS:
                text = plugin().process(text)
        else:
            for plugin in plugins:
                text = plugin().process(text)
        return text

    @classmethod
    def plugin(cls, plugin):
        cls.PLUGINS.append(plugin)
        return plugin


@TextProcessor.plugin
class CleanMarkdownBolds(object):
    def process(self, text):
        return text.replace('**', '')

용법:

processor = TextProcessor()
processed = processor.process(text="**foo bar**", plugins=(CleanMarkdownBolds, ))
processed = processor.process(text="**foo bar**")