python-igraph API 参考

类文档

class Configuration

表示 igraph 配置详细信息的类。

请注意，这个类只有一个主要实例，igraph 本身在需要时使用它来检索配置参数。您可以使用 instance() 方法访问此实例。您可以通过直接调用构造函数来构造其他实例，但这些实例不会影响 igraph 的行为。如果您有兴趣配置 igraph，请使用 igraph.config 来获取单例实例，然后对其进行修改。

通用概念

igraph 的配置以名称-值对的形式存储。此对象使用 dict 中已知的语法提供配置数据的接口

>>> c = Configuration()
>>> c["general.verbose"] = True
>>> print(c["general.verbose"])
True

配置键被组织成多个部分，给定键的名称始终采用以下形式section.keyname，例如general.verbose在上面的例子中，general是配置部分的名称，而verbose是键的名称。如果省略了部分的名称，则默认为general，因此general.verbose可以称为verbose:

>>> c = Configuration()
>>> c["verbose"] = True
>>> print(c["general.verbose"])
True

用户级别的配置默认存储在~/.igraphrcLinux 和 Mac OS X 系统上，或者C:\Documents 和 Settings\username\.igraphrc在 Windows 系统上。但是，只有当igraph通过其在 igraph.app.shell 中定义的 shell 界面启动时，才会读取此配置。在 1.0 版本之前，此行为可能会更改。

已知的配置键

下面列出了已知的配置键，按部分排序。在程序代码中引用它们时，请不要忘记添加部分名称，除了部分general.

常规设置

这些设置都存储在部分general.

shells: 与命令行一起使用的首选 Python shell 列表igraph脚本。列表中的 shell 会一个接一个地尝试，直到在系统上找到任何一个。然后将igraph函数导入到 shell 的主命名空间中，并启动 shell。可以在 igraph.app.shell 中找到已知的 shell 及其各自要使用的类名。例子IPythonShell, ClassicPythonShell。顺便说一下，这是默认设置。
verbose: igraph 是否应该说比实际需要更多的话。例如，如果设置为True，某些函数会显示进度条。

绘图设置

这些设置指定绘图函数使用的默认值。它们都存储在部分plotting.

backend: 如果您想使用 Cairo 进行绘图，则为“cairo”，如果您想使用 Matplotlib 绘图后端，则为“matplotlib”。
layout: 要使用的默认图布局算法。
mark_groups: 绘制聚类对象时是否用多边形标记聚类。
palette: 用于将整数转换为颜色的默认调色板。有关更多信息，请参见 colors.Palette。有效的调色板名称存储在colors.palettes.
wrap_labels: 如果顶点标签不适合顶点，是否尝试自动换行。默认False.

Shell 设置

这些设置指定 igraph 嵌入的外部环境（例如，IPython 及其 Qt 控制台）的选项。这些设置存储在部分shell.

ipython.inlining.Plot: 如果控制台支持，是否在 IPython 的控制台中内联显示 Plot 类的实例。默认True

类	`类型`	用于实现配置键的自定义 getter/setter 函数的静态类
类方法	`instance`	返回配置对象的单个实例。
方法	`__contains__`	检查是否设置了给定的配置项。
方法	`__delitem__`	从配置中删除给定的项。
方法	`__getitem__`	返回给定的配置项。
方法	`__init__`	创建一个新的配置实例。
方法	`__setitem__`	设置给定的配置项。
方法	`has_key`	检查配置是否具有给定的键。
方法	`load`	从给定文件加载配置。
方法	`save`	保存配置。
属性	`filename`	返回与对象关联的文件名。
静态方法	`_item_to_section_key`	将项目描述转换为 section-key 对。
方法	`_get`	内部函数，返回给定部分中给定键的值。
类变量	`_definitions`	未归档
类变量	`_instance`	未归档
类变量	`_sections`	未归档
类变量	`_types`	未归档
实例变量	`_config`	未归档
实例变量	`_filename`	未归档

@classmethod
def instance(cls): ¶

返回配置对象的单个实例。

def __contains__(self, item): ¶

检查是否设置了给定的配置项。

参数
item	要检查的配置键。
返回值
`True`如果键具有关联的值，`False`否则。

def __delitem__(self, item): ¶

从配置中删除给定的项。

如果项目具有默认值，则写回默认值而不是当前值。如果没有默认值，则该项将被真正删除。

def __getitem__(self, item): ¶

返回给定的配置项。

参数
item	要检索的配置键。
返回值
配置值

def __init__(self, filename=None): ¶

创建一个新的配置实例。

参数
filename	要读取的文件或文件指针。可以省略。

def __setitem__(self, item, value): ¶

设置给定的配置项。

参数
item	要设置的配置键
value	配置键的新值

def has_key(self, item): ¶

检查配置是否具有给定的键。

参数
item	要查找的键

def load(self, stream=None): ¶

从给定文件加载配置。

参数
stream	文件或文件对象的名称。配置将从此处加载。可以省略，在这种情况下，将加载用户级别的配置。

def save(self, stream=None): ¶

保存配置。

参数
stream	文件或文件对象的名称。配置将保存在那里。可以省略，在这种情况下，用户级别的配置文件将被覆盖。

@property
filename = ¶

返回与对象关联的文件名。

通常是创建对象时使用的配置文件的名称。Configuration.load 始终使用给定的文件名覆盖它。如果None，则配置要么是从头创建的，要么是从没有名称信息的流更新的。

@staticmethod
def _item_to_section_key(item): ¶

将项目描述转换为 section-key 对。

参数
item	要转换的项
返回值
如果`item`包含一个句点 (`.`)，则它在第一个句点处被分成两部分，然后返回这两部分，因此句点之前的部分是部分。如果`item`不包含句点，则假定该部分为`general`，并且返回对的第二部分包含`item`未更改

def _get(self, section, key): ¶

内部函数，返回给定部分中给定键的值。

_definitions: dict = ¶

未归档

_instance = ¶

未归档

_sections: tuple[str, ...] = ¶

未归档

_types = ¶

未归档

_config = ¶

未归档

_filename = ¶

未归档

igraph.Configuration

通用概念

已知的配置键

常规设置

绘图设置

Shell 设置

`igraph.Configuration`