LibreOffice5(156)ドキュメントに埋め込んだモジュールをインポートする 撤廃メソッドの排除

2018-09-12

旧ブログ

t f B! P L
LibreOffice5(120)ドキュメントに埋め込んだモジュールをインポートするのtdocimport.pyではfind_module()メソッドとload_module()メソッドを実装していましたが、撤廃メソッドなのでそれらを新たなメソッドに置換します。但し、Python3.4以上でしか動かないのでWindows版LibreOfficeでは5.4以上でないと動きません。

前の関連記事:LibreOffice5(155)ログからPythonマクロの律速段階を調べる


ソースローダーのload_module()メソッドをcreate_module()メソッドとexec_module()メソッドに分割する


ソースローダーが継承するimportlib.abc.SourceLoaderクラスはソース ファイルのロードを実装する抽象基底クラスです。

まずimportlib.abc.SourceLoaderクラスのload_module()メソッドをやめて、create_module()メソッドとexec_module()メソッドに置き換えます。

load_module()メソッドではソースファイルのパスを引数にとって、そこからコードオブジェクトを取得して、モジュールパスの辞書に登録した後、モジュールオブジェクトを実行してモジュールオブジェクトを返していました。

それをモジュールオブジェクトを作成する部分と、モジュールオブジェクトを実行する部分に分割して、それぞれcreate_module()メソッドとexec_module()メソッドに割り当てます。
 def load_module(self, fullname):  # Required method。引数はimport文で使うフルネーム。
  code = self.get_code(fullname)  # モジュールのコードオブジェクトを取得。
  mod = sys.modules.setdefault(fullname, ModuleType(fullname))  # 辞書sys.modulesにキーfullnameなければ値を代入して値を取得。
  mod.__file__ = self.get_filename(fullname)  # ソースファイルへのフルパスを取得。
  mod.__loader__ = self  # ローダーを取得。
  mod.__package__ = fullname.rpartition('.')[0]  # パッケージ名を取得。.区切りがないときは空文字が入る。
  exec(code, mod.__dict__)  # コードオブジェクトを実行する。
  return mod  # モジュールオブジェクトを返す。
つまりこのload_module()メソッドの実装の2行目と7行目を削除するとcreate_module()メソッドになります。

ただ、create_module()が引数がモジュールヘのパス(ファイルシステムでのパスではなく、Python内でのパス)ではなく、importlib.machinery.ModuleSpecクラスのインスタンスに変更になります。

create_module()メソッド内で利用するのはモジュール名だけなので、それをnameアトリビュートで取得します。
 def create_module(self, spec):  #  specからモジュールを作成して返す。
  mod = sys.modules.setdefault(spec.name, ModuleType(spec.name))  # 辞書sys.modulesにキーfullnameなければ値を代入して値を取得。
  mod.__file__ = self.get_filename(spec.name)  # ソースファイルへのフルパスを取得。
  mod.__loader__ = self  # ローダーを取得。
  mod.__package__ = spec.name.rpartition('.')[0]  # パッケージ名を取得。.区切りがないときは空文字が入る。
  return mod
これでcreate_module()メソッドはできあがりです。
 def exec_module(self, module):  # モジュールを実行。
  code = self.get_code(module.__name__)
  exec(code, module.__dict__)
exec_module()メソッドは引数をモジュールオブジェクトにとるので、そこからコードオブジェクトを取得して実行しています。

コンパイル後のバイトコードをどこかに保存しておけば、ドキュメントのロードが速くなりそうなのですが、ドキュメント内への保存のコストとの兼ね合いを考えると速さはそうかわらないのかもしれませんし、そもそもどうやってドキュメント内にバイトコードを埋め込むのか考えないといけないのでいまのところバイトコードの保存は実装していません。
 def create_module(self, spec):
  mod = super().create_module(spec)  # __init__.pyを取得。
  mod.__path__ = [self._baseurl]  # パッケージ内の検索パスを指定する文字列のリスト
  mod.__package__ = spec.name  # フォルダ名を入れる。
  return mod
パッケージローダーのload_module()メソッドの書き換えは引数の変更に倣うだけです。

Python Cookbook10.11.loading_modules_from_a_remote_machine_using_import_hooksの例ではパッケージローダーのload_module()メソッドは何も返していないのですが、create_module()メソッドではモジュールを返すようにしました。

これで__init__.pyもちゃんと実行されるようになるかもしれません(未確認)。

メタパスファインダーのfind_module()メソッドをfind_spec()メソッドに置き換える


メタパスファインダーが継承するimportlib.abc.MetaPathFinderクラスはsys.meta_path を検索して得られるファインダーです。

find_module()メソッドはモジュールのパスからローダーを返すものですが、これをfind_spec()に置き換えます。

find_spec()はオプション引数を除いてfind_module()メソッドと引数は同じですが、戻り値はローダーではなく、importlib.machinery.ModuleSpecクラスのインスタンスになります。

importlib.machinery.ModuleSpecクラスのインスタンスはローダーを与えてインスタンス化するだけなので、find_module()メソッドからの変更点はそこだけです。

Python3.4以上用のtdocimport.py

import sys
import importlib.abc
from types import ModuleType
from importlib.machinery import ModuleSpec
def _get_links(simplefileaccess, url):  # url内のファイル名とフォルダ名のリストを返す関数。
 foldercontents = simplefileaccess.getFolderContents(url, True)  # url内のファイルとフォルダをすべて取得。フルパスで返ってくる。
 tdocpath = "".join((url, "/"))  # 除去するパスの部分を作成。
 return [content.replace(tdocpath, "") for content in foldercontents]  # ファイル名かフォルダ名だけのリストにして返す。
class UrlMetaFinder(importlib.abc.MetaPathFinder):  # meta path finderの実装。
 def __init__(self, simplefileaccess, baseurl):
  self._simplefileaccess = simplefileaccess  # LibreOfficeドキュメント内のファイルにアクセスするためのsimplefileaccess
  self._baseurl = baseurl  # モジュールを探すパス
  self._links   = {}  # baseurl内のファイル名とフォルダ名のリストのキャッシュにする辞書。。
  self._loaders = {baseurl: UrlModuleLoader(simplefileaccess, baseurl)}  # ローダーのキャッシュにする辞書。
 def find_spec(self, fullname, path=None, target=None):  # ModuleSpecを返す。
  if path is None:
   baseurl = self._baseurl
  else:
   if not path[0].startswith(self._baseurl):
    return None
   baseurl = path[0]
  parts = fullname.split('.')
  basename = parts[-1]
  if basename not in self._links:  # Check link cache
   self._links[baseurl] = _get_links(self._simplefileaccess, baseurl)
  if basename in self._links[baseurl]:  # Check if it's a package。パッケージの時。
   fullurl = "/".join((self._baseurl, basename))
   loader = UrlPackageLoader(self._simplefileaccess, fullurl)
   try:  # Attempt to load the package (which accesses __init__.py)
    loader.load_module(fullname)
    self._links[fullurl] = _get_links(self._simplefileaccess, fullurl)
    self._loaders[fullurl] = UrlModuleLoader(self._simplefileaccess, fullurl)
   except ImportError:
    loader = None
   return loader
  filename = "".join((basename, '.py'))
  if filename in self._links[baseurl]:  # A normal module
   return ModuleSpec(fullname, self._loaders[baseurl], origin=path)
  else:
   return None
 def invalidate_caches(self):
  self._links.clear()
class UrlModuleLoader(importlib.abc.SourceLoader):  # Module Loader for a URL
 def __init__(self, simplefileaccess, baseurl):
  self._simplefileaccess = simplefileaccess  # LibreOfficeドキュメント内のファイルにアクセスするためのsimplefileaccess
  self._baseurl = baseurl  # モジュールを探すパス
  self._source_cache = {}  # ソースのキャッシュの辞書。
 def module_repr(self, module):  # モジュールを表す文字列を返す。
  return '<urlmodule {} from {}>'.format(module.__name__, module.__file__)
 def create_module(self, spec):  #  specからモジュールを作成して返す。
  mod = sys.modules.setdefault(spec.name, ModuleType(spec.name))  # 辞書sys.modulesにキーfullnameなければ値を代入して値を取得。
  mod.__file__ = self.get_filename(spec.name)  # ソースファイルへのフルパスを取得。
  mod.__loader__ = self  # ローダーを取得。
  mod.__package__ = spec.name.rpartition('.')[0]  # パッケージ名を取得。.区切りがないときは空文字が入る。
  return mod
 def exec_module(self, module):  # モジュールを実行。
  code = self.get_code(module.__name__)
  exec(code, module.__dict__)
 def get_code(self, fullname):  # モジュールのコードオブジェクトを返す。Optional extensions。引数はimport文で使うフルネーム。
  src = self.get_source(fullname)
  return compile(src, self.get_filename(fullname), 'exec')
 def get_data(self, path):  # バイナリ文字列を返す。
  pass
 def get_filename(self, fullname):  # ソースファイルへのフルパスを返す。引数はimport文で使うフルネーム。
  return "".join((self._baseurl, '/', fullname.split('.')[-1], '.py'))
 def get_source(self, fullname):  # モジュールのソースをテキストで返す。
  filename = self.get_filename(fullname)  # ソースファイルへのフルパス。
  if filename in self._source_cache:  # すでにキャッシュがあればそれを返して終わる。
   return self._source_cache[filename]
  try:
   inputstream = self._simplefileaccess.openFileRead(filename)  # ソースファイルのインプットストリームを取得。
   dummy, b = inputstream.readBytes([], inputstream.available())  # simplefileaccess.getSize(module_tdocurl)は0が返る。
   source = bytes(b).decode("utf-8")  # モジュールのソースファイルをutf-8のテキストで取得。
   self._source_cache[filename] = source  # ソースをキャッシュに取得。
   return source  # ソースのテキストを返す。
  except:
   raise ImportError("Can't load {}".format(filename))
 def is_package(self, fullname):  # パッケージの時はTrueを返す。
  return False
class UrlPackageLoader(UrlModuleLoader):  # Package loader for a URL
 def create_module(self, spec):
  mod = super().create_module(spec)  # __init__.pyを取得。
  mod.__path__ = [self._baseurl]  # パッケージ内の検索パスを指定する文字列のリスト
  mod.__package__ = spec.name  # フォルダ名を入れる。
  return mod
 def get_filename(self, fullname):  # パッケージの__init__.pyを返す。
  return "/".join((self._baseurl, '__init__.py'))
 def is_package(self, fullname):  # パッケージの時はTrueを返す。
  return True
_installed_meta_cache = {}  # meta path finderを入れておくグローバル辞書。重複を防ぐ目的。
def install_meta(simplefileaccess, address):  # Utility functions for installing the loader
 if address not in _installed_meta_cache:  # グローバル辞書にないパスの時。
  finder = UrlMetaFinder(simplefileaccess, address)  # meta path finder。モジュールを探すクラスをインスタンス化。
  _installed_meta_cache[address] = finder  # グローバル辞書にmeta path finderを登録。
  sys.meta_path.append(finder)  # meta path finderをsys.meta_pathに登録。
def remove_meta(address):  # Utility functions for uninstalling the loader
 if address in _installed_meta_cache:
  finder = _installed_meta_cache.pop(address)
  sys.meta_path.remove(finder)

撤廃となったメソッドを置き換えただけなので、使い方はLibreOffice5(120)ドキュメントに埋め込んだモジュールをインポートするのtdocimport.pyと同じです。

参考にしたサイト


import_hook · python攻略
find_spec()の実装例。撤廃になっているimp.new_moduleを使用しています。

次の関連記事:LibreOffice5(157)ページスタイルのサービスとインターフェイスの一覧

ブログ検索 by Blogger

Translate

最近のコメント

Created by Calendar Gadget

QooQ