OpenQuizz
Une application de gestion des contenus pédagogiques
Metadata Class Reference
Inheritance diagram for Metadata:
Collaboration diagram for Metadata:

Public Member Functions

def __init__ (self, path=None, fileobj=None, mapping=None, scheme='default')
 
def __getattribute__ (self, key)
 
def __setattr__ (self, key, value)
 
def name_and_version (self)
 
def provides (self)
 
def provides (self, value)
 
def get_requirements (self, reqts, extras=None, env=None)
 
def dictionary (self)
 
def dependencies (self)
 
def dependencies (self, value)
 
def validate (self)
 
def todict (self)
 
def write (self, path=None, fileobj=None, legacy=False, skip_unknown=True)
 
def add_requirements (self, requirements)
 
def __repr__ (self)
 

Data Fields

 scheme
 

Static Public Attributes

 METADATA_VERSION_MATCHER
 
 NAME_MATCHER
 
 VERSION_MATCHER
 
 SUMMARY_MATCHER
 
 METADATA_VERSION
 
 GENERATOR
 
 MANDATORY_KEYS
 
 INDEX_KEYS
 
 DEPENDENCY_KEYS
 
 SYNTAX_VALIDATORS
 
 common_keys
 
 none_list
 
 none_dict
 
 mapped_keys
 
 LEGACY_MAPPING
 

Detailed Description

The metadata of a release. This implementation uses 2.0 (JSON)
metadata where possible. If not possible, it wraps a LegacyMetadata
instance which handles the key-value metadata format.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  path = None,
  fileobj = None,
  mapping = None,
  scheme = 'default' 
)

Member Function Documentation

◆ __getattribute__()

def __getattribute__ (   self,
  key 
)

◆ __repr__()

def __repr__ (   self)

◆ __setattr__()

def __setattr__ (   self,
  key,
  value 
)

◆ add_requirements()

def add_requirements (   self,
  requirements 
)

◆ dependencies() [1/2]

def dependencies (   self)

◆ dependencies() [2/2]

def dependencies (   self,
  value 
)

◆ dictionary()

def dictionary (   self)

◆ get_requirements()

def get_requirements (   self,
  reqts,
  extras = None,
  env = None 
)
Base method to get dependencies, given a set of extras
to satisfy and an optional environment context.
:param reqts: A list of sometimes-wanted dependencies,
      perhaps dependent on extras and environment.
:param extras: A list of optional components being requested.
:param env: An optional environment for marker evaluation.

◆ name_and_version()

def name_and_version (   self)

◆ provides() [1/2]

def provides (   self)

◆ provides() [2/2]

def provides (   self,
  value 
)

◆ todict()

def todict (   self)

◆ validate()

def validate (   self)

◆ write()

def write (   self,
  path = None,
  fileobj = None,
  legacy = False,
  skip_unknown = True 
)

Field Documentation

◆ common_keys

common_keys
static

◆ DEPENDENCY_KEYS

DEPENDENCY_KEYS
static

◆ GENERATOR

GENERATOR
static

◆ INDEX_KEYS

INDEX_KEYS
static

◆ LEGACY_MAPPING

LEGACY_MAPPING
static

◆ MANDATORY_KEYS

MANDATORY_KEYS
static

◆ mapped_keys

mapped_keys
static

◆ METADATA_VERSION

METADATA_VERSION
static

◆ METADATA_VERSION_MATCHER

METADATA_VERSION_MATCHER
static

◆ NAME_MATCHER

NAME_MATCHER
static

◆ none_dict

none_dict
static

◆ none_list

none_list
static

◆ scheme

scheme

◆ SUMMARY_MATCHER

SUMMARY_MATCHER
static

◆ SYNTAX_VALIDATORS

SYNTAX_VALIDATORS
static

◆ VERSION_MATCHER

VERSION_MATCHER
static

The documentation for this class was generated from the following file: