pmfp.entrypoint.schema.check

检测json schema的example是否符合定义的模式schema.

Submodules

• pmfp.entrypoint.schema.check.core

Package Contents

Functions

is_url(url: str) → bool	判断url是否是url.
is_http_url(url: str) → bool	判断url是否是http请求的url.
is_file_url(url: str) → bool	判断url是否是文件协议相关的url.
parse_file_url(url: str) → str	从file url中提取文件系统中的路径.
get_source_from_url(url: str) → str	从指定url中回去源数据.
is_validated(instance: Dict[str, Any], schema: Dict[str, Any]) → bool	检测数据是否符合模式.
test_http(schema: str, serialization: str, url: str, method: str, *, auth: Optional[str] = None, auth_type: Optional[str] = None, payload: Optional[str] = None, payload_type: Optional[str] = None, stream: bool = False, verify: bool = False, cert: Optional[str] = None) → None	检测http请求的结果是否满足模式.
check_schema(schema: str, serialization: str, url: str, method: str, *, auth: Optional[str] = None, auth_type: Optional[str] = None, payload: Optional[str] = None, payload_type: Optional[str] = None, stream: bool = False, verify: bool = False, cert: Optional[str] = None) → None	检测指定的数据是否满足模式.

Attributes

schema_check

pmfp.entrypoint.schema.check.is_url(url: str) → bool

判断url是否是url.

参数

url (str) – 待判断的url字符串

返回

是否是url

返回类型

bool

pmfp.entrypoint.schema.check.is_http_url(url: str) → bool

判断url是否是http请求的url.

参数

url (str) – 待判断的url字符串

返回

是否是url

返回类型

bool

pmfp.entrypoint.schema.check.is_file_url(url: str) → bool

判断url是否是文件协议相关的url.

参数

url (str) – 待判断的url字符串

返回

是否是url

返回类型

bool

pmfp.entrypoint.schema.check.parse_file_url(url: str) → str

从file url中提取文件系统中的路径.

参数

url (str) – file url

返回

file url中提取出的路径

返回类型

str

pmfp.entrypoint.schema.check.get_source_from_url(url: str) → str

从指定url中回去源数据.

注意只能获取静态http资源.

参数

url (str) – url地址

引发

• AttributeError – url未成功返回

• AttributeError – 未支持的类型

返回

内容文本

返回类型

str

pmfp.entrypoint.schema.check.is_validated(instance: Dict[str, Any], schema: Dict[str, Any]) → bool

检测数据是否符合模式.

参数

• instance (Dict[str,Any]) – 待检测数据

• schema (Dict[str,Any]) – 需要满足的模式

返回

是否通过验证

返回类型

bool

pmfp.entrypoint.schema.check.test_http(schema: str, serialization: str, url: str, method: str, *, auth: Optional[str] = None, auth_type: Optional[str] = None, payload: Optional[str] = None, payload_type: Optional[str] = None, stream: bool = False, verify: bool = False, cert: Optional[str] = None) → None

检测http请求的结果是否满足模式.

参数

• schema (str) – 模式的地址,可以是url或者文件路径.

• serialization (str) – 使用的序列化协议.

• url (str) – 要访问的http资源的地址.

• method (str) – 访问资源的方法.

• auth (Optional[str], optional) – 用户身份验证字符串. Defaults to None.

• auth_type (Optional[str], optional) – 用户身份的验证类型. Defaults to None.

• payload (Optional[str], optional) – 请求负载. Defaults to None.

• payload_type (Optional[str], optional) – 请求的负载类型. Defaults to None.

• stream (bool, optional) – 返回是否为流数据. Defaults to False.

• verify (bool, optional) – https请求是否验证. Defaults to False.

• cert (Optional[str], optional) – https请求的客户端认证文件. Defaults to None.

• cb (Optional[Callable[[str],]], optional) – 获取到数据后的处理回调. Defaults to None.

pmfp.entrypoint.schema.check.schema_check

pmfp.entrypoint.schema.check.check_schema(schema: str, serialization: str, url: str, method: str, *, auth: Optional[str] = None, auth_type: Optional[str] = None, payload: Optional[str] = None, payload_type: Optional[str] = None, stream: bool = False, verify: bool = False, cert: Optional[str] = None) → None

检测指定的数据是否满足模式.

参数

• schema (str) – 模式的地址,可以是url或者文件路径.

• serialization (str) – 使用的序列化协议.

• url (str) – “请求的路径,可以是http/file的url或者文件系统的路径”.

• method (str) – 访问资源的方法.

• auth (Optional[str], optional) – 用户身份验证字符串. Defaults to None.

• auth_type (Optional[str], optional) – 用户身份的验证类型. Defaults to None.

• payload (Optional[str], optional) – 请求负载. Defaults to None.

• payload_type (Optional[str], optional) – 请求的负载类型. Defaults to None.

• stream (bool, optional) – 返回是否为流数据. Defaults to False.

• verify (bool, optional) – https请求是否验证. Defaults to False.

• cert (Optional[str], optional) – https请求的客户端认证文件. Defaults to None.