摘要
我真的很喜欢 f 字符串。它们是血腥的真棒语法。
一段时间以来，我一直有一个想法，即建立一个小库 - 如下所述*- 以进一步利用它们。我希望它做什么的快速示例：
>>> import simpleformatter as sf
>>> def format_camel_case(string):
... """camel cases a sentence"""
... return ''.join(s.capitalize() for s in string.split())
...
>>> @sf.formattable(camcase=format_camel_case)
... class MyStr(str): ...
...
>>> f'{MyStr("lime cordial delicious"):camcase}'
'LimeCordialDelicious'
对于简化的 API 和将用法扩展到内置类实例，找到一种挂钩到内置 python 格式化机制的方法将非常有用，这将允许内置的自定义格式规范：
>>> f'{"lime cordial delicious":camcase}'
'LimeCordialDelicious'
换句话说，我想覆盖内置的format函数(由 f 字符串语法使用)——或者，扩展现有标准库类的内置__format__方法——这样我就可以写这样的东西：
for x, y, z in complicated_generator:
eat_string(f"x: {x:custom_spec1}, y: {x:custom_spec2}, z: {x:custom_spec3}")
我已经通过使用自己的__format__方法创建子类来实现了这一点，但这当然不适用于内置类。
我可以使用string.Formatterapi接近它：
my_formatter=MyFormatter() # custom string.Formatter instance
format_str = "x: {x:custom_spec1}, y: {x:custom_spec2}, z: {x:custom_spec3}"
for x, y, z in complicated_generator:
eat_string(my_formatter.format(format_str, **locals()))
我发现这有点笨拙，与 f 字符串 API 相比绝对不可读。
可以做的另一件事是覆盖builtins.format：
>>> import builtins
>>> builtins.format = lambda *args, **kwargs: 'womp womp'
>>> format(1,"foo")
'womp womp'
。但这不适用于 F 字符串：
>>> f"{1:foo}"
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: Invalid format specifier
详情
目前我的 API 看起来像这样(有些简化)：
import simpleformatter as sf
@sf.formatter("this_specification")
def this_formatting_function(some_obj):
return "this formatted someobj!"
@sf.formatter("that_specification")
def that_formatting_function(some_obj):
return "that formatted someobj!"
@sf.formattable
class SomeClass: ...
之后，您可以编写如下代码：
some_obj = SomeClass()
f"{some_obj:this_specification}"
f"{some_obj:that_specification}"
我希望 api 更像下面：
@sf.formatter("this_specification")
def this_formatting_function(some_obj):
return "this formatted someobj!"
@sf.formatter("that_specification")
def that_formatting_function(some_obj):
return "that formatted someobj!"
class SomeClass: ... # no class decorator needed
。并允许在内置类上使用自定义格式规范：
x=1 # built-in type instance
f"{x:this_specification}"
f"{x:that_specification}"
但是为了做这些事情，我们必须钻进内置的format()函数中。我怎样才能钩住那多汁的 f 弦好东西？
*注意：我可能永远不会真正实现这个库！但我确实认为这是一个好主意，并邀请任何想要的人，从我这里偷走它:)。
概述
你可以，但前提是你编写了可能永远不应该出现在生产软件中的邪恶代码。所以让我们开始吧！
我不打算将其集成到您的库中，但我会向您展示如何挂钩到 f 字符串的行为中。大致是这样工作的：
- 编写一个函数，操作代码对象的字节码指令，将
FORMAT_VALUE指令替换为对钩子函数的调用; - 自定义导入机制，以确保使用该函数修改每个模块和包(标准库模块和站点包除外)的字节码。
您可以在 https://github.com/mivdnber/formathack 获得完整的源代码，但所有内容都在下面解释。
免責聲明
这个解决方案不是很好，因为
完全- 不能保证这不会破坏完全不相关的代码;
- 无法保证此处描述的字节码操作将在较新的 Python 版本中继续工作。它绝对不适用于无法编译为CPython兼容字节码的替代Python实现。PyPy 理论上可以工作，但这里描述的解决方案不能，因为字节码包不是 100% 兼容的。
但是，这是一个解决方案，字节码操作已在PonyORM等流行软件包中成功使用。请记住，它很笨拙，复杂，而且可能维护繁重。
第1部分：字节码操作
Python代码不是直接执行的，而是首先编译成一种更简单的中间，非人类可读的基于堆栈的语言，称为Python字节码(它是*.pyc文件内部的内容)。要了解该字节码的外观，您可以使用标准库 dis 模块来检查简单函数的字节码：
def invalid_format(x):
return f"{x:foo}"
调用此函数将导致异常，但我们很快就会"修复"它。
>>> invalid_format("bar")
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "<stdin>", line 2, in invalid_format
ValueError: Invalid format specifier
要检查字节码，请启动 Python 控制台并调用dis.dis：
>>> import dis
>>> dis.dis(invalid_format)
2 0 LOAD_FAST 0 (x)
2 LOAD_CONST 1 ('foo')
4 FORMAT_VALUE 4 (with format)
6 RETURN_VALUE
我在下面注释了输出以解释正在发生的事情：
# line 2 # Put the value of function parameter x on the stack
2 0 LOAD_FAST 0 (x)
# Put the format spec on the stack as a string
2 LOAD_CONST 1 ('foo')
# Pop both values from the stack and perform the actual formatting
# This puts the formatted string on the stack
4 FORMAT_VALUE 4 (with format)
# pop the result from the stack and return it
6 RETURN_VALUE
这里的想法是用对钩子函数的调用替换FORMAT_VALUE指令，该函数允许我们实现我们想要的任何行为。现在让我们像这样实现它：
def formathack_hook__(value, format_spec=None):
"""
Gets called whenever a value is formatted. Right now it's a silly implementation,
but it can be expanded with all sorts of nasty hacks.
"""
return f"{value} formatted with {format_spec}"
为了替换指令，我使用了字节码包，它为做可怕的事情提供了令人惊讶的很好的抽象。
from bytecode import Bytecode
def formathack_rewrite_bytecode__(code):
"""
Modifies a code object to override the behavior of the FORMAT_VALUE
instructions used by f-strings.
"""
decompiled = Bytecode.from_code(code)
modified_instructions = []
for instruction in decompiled:
name = getattr(instruction, 'name', None)
if name == 'FORMAT_VALUE':
# 0x04 means that a format spec is present
if instruction.arg & 0x04 == 0x04:
callback_arg_count = 2
else:
callback_arg_count = 1
modified_instructions.extend([
# Load in the callback
Instr("LOAD_GLOBAL", "formathack_hook__"),
# Shuffle around the top of the stack to put the arguments on top
# of the function global
Instr("ROT_THREE" if callback_arg_count == 2 else "ROT_TWO"),
# Call the callback function instead of executing FORMAT_VALUE
Instr("CALL_FUNCTION", callback_arg_count)
])
# Kind of nasty: we want to recursively alter the code of functions.
elif name == 'LOAD_CONST' and isinstance(instruction.arg, types.CodeType):
modified_instructions.extend([
Instr("LOAD_CONST", formathack_rewrite_bytecode__(instruction.arg), lineno=instruction.lineno)
])
else:
modified_instructions.append(instruction)
modified_bytecode = Bytecode(modified_instructions)
# For functions, copy over argument definitions
modified_bytecode.argnames = decompiled.argnames
modified_bytecode.argcount = decompiled.argcount
modified_bytecode.name = decompiled.name
return modified_bytecode.to_code()
现在，我们可以使之前定义的invalid_format函数正常工作：
>>> invalid_format.__code__ = formathack_rewrite_bytecode__(invalid_format.__code__)
>>> invalid_format("bar")
'bar formatted with foo'
成功！不过，手动诅咒带有受污染字节码的代码对象本身不会使我们的灵魂遭受永恒的痛苦;为此，我们应该自动操作所有代码。
第 2 部分：挂钩到导入过程
为了使新的 f-string 行为在任何地方都能正常工作，而不仅仅是在手动修补的函数中，我们可以使用标准库 importlib 模块提供的功能，使用自定义模块查找器和加载器自定义 Python 模块导入过程：
class _FormatHackLoader(importlib.machinery.SourceFileLoader):
"""
A module loader that modifies the code of the modules it imports to override
the behavior of f-strings. Nasty stuff.
"""
@classmethod
def find_spec(cls, name, path, target=None):
# Start out with a spec from a default finder
spec = importlib.machinery.PathFinder.find_spec(
fullname=name,
# Only apply to modules and packages in the current directory
# This prevents standard library modules or site-packages
# from being patched.
path=[""],
target=target
)
if spec is None:
return None
# Modify the loader in the spec to this loader
spec.loader = cls(name, spec.origin)
return spec
def get_code(self, fullname):
# This is called by exec_module to get the code of the module
# to execute it.
code = super().get_code(fullname)
# Rewrite the code to modify the f-string formatting opcodes
rewritten_code = formathack_rewrite_bytecode__(code)
return rewritten_code
def exec_module(self, module):
# We introduce the callback that hooks into the f-string formatting
# process in every imported module
module.__dict__["formathack_hook__"] = formathack_hook__
return super().exec_module(module)
为了确保 Python 解释器使用此加载器导入所有文件，我们必须将其添加到sys.meta_path：
def install():
# If the _FormatHackLoader is not registered as a finder,
# do it now!
if sys.meta_path[0] is not _FormatHackLoader:
sys.meta_path.insert(0, _FormatHackLoader)
# Tricky part: we want to be able to use our custom f-string behavior
# in the main module where install was called. That module was loaded
# with a standard loader though, so that's impossible without additional
# dirty hacks.
# Here, we execute the module _again_, this time with _FormatHackLoader
module_globals = inspect.currentframe().f_back.f_globals
module_name = module_globals["__name__"]
module_file = module_globals["__file__"]
loader = _FormatHackLoader(module_name, module_file)
loader.load_module(module_name)
# This is actually pretty important. If we don't exit here, the main module
# will continue from the formathack.install method, causing it to run twice!
sys.exit(0)
如果我们将它们全部放在一个formathack模块中(有关集成的工作示例，请参阅 https://github.com/mivdnber/formathack)，我们现在可以像这样使用它：
# In your main Python module, install formathack ASAP
import formathack
formathack.install()
# From now on, f-string behavior will be overridden!
print(f"{foo:bar}")
# -> "foo formatted with bar"
原来如此！您可以对此进行扩展，使钩子函数更加智能和有用(例如，通过注册处理某些格式说明符的函数)。