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

Public Member Functions

def __init__ (self, repo)
 
def update (self, previous_commit=None, recursive=True, force_remove=False, init=True, to_latest_revision=False, progress=None, dry_run=False, force_reset=False, keep_going=False)
 
def module (self)
 
- Public Member Functions inherited from Submodule
def __init__ (self, repo, binsha, mode=None, path=None, name=None, parent_commit=None, url=None, branch_path=None)
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def __str__ (self)
 
def __repr__ (self)
 
def add (cls, repo, name, path, url=None, branch=None, no_checkout=False, depth=None, env=None)
 
def update (self, recursive=False, init=True, to_latest_revision=False, progress=None, dry_run=False, force=False, keep_going=False, env=None)
 
def move (self, module_path, configuration=True, module=True)
 
def remove (self, module=True, force=False, configuration=True, dry_run=False)
 
def set_parent_commit (self, commit, check=True)
 
def config_writer (self, index=None, write=True)
 
def rename (self, new_name)
 
def module_exists (self)
 
def exists (self)
 
def branch (self)
 
def branch_path (self)
 
def branch_name (self)
 
def url (self)
 
def parent_commit (self)
 
def name (self)
 
def config_reader (self)
 
def children (self)
 
def iter_items (cls, repo, parent_commit='HEAD')
 
- Public Member Functions inherited from IndexObject
def __init__ (self, repo, binsha, mode=None, path=None)
 
def abspath (self)
 
- Public Member Functions inherited from Object
def __init__ (self, repo, binsha)
 
def new (cls, repo, id)
 
def new_from_sha (cls, repo, sha1)
 
def hexsha (self)
 
def data_stream (self)
 
def stream_data (self, ostream)
 
- Public Member Functions inherited from Iterable
def list_items (cls, repo, *args, **kwargs)
 
def iter_items (cls, repo, *args, **kwargs)
 
- Public Member Functions inherited from Traversable
def list_traverse (self, *args, **kwargs)
 
def traverse (self, predicate=lambda i, True d, prune=lambda i, False d, depth=-1, branch_first=True, visit_once=True, ignore_self=1, as_edge=False)
 

Static Public Attributes

 k_root_name
 
- Static Public Attributes inherited from Submodule
 k_modules_file
 
 k_head_option
 
 k_head_default
 
 k_default_mode
 
 type
 
- Static Public Attributes inherited from Object
 NULL_HEX_SHA
 
 NULL_BIN_SHA
 
 TYPES
 
 type
 

Additional Inherited Members

- Data Fields inherited from Submodule
 size
 
 path
 
 binsha
 
 name
 
- Data Fields inherited from IndexObject
 mode
 
 path
 
- Data Fields inherited from Object
 repo
 
 binsha
 
 size
 

Detailed Description

A (virtual) Root of all submodules in the given repository. It can be used
to more easily traverse all submodules of the master repository

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  repo 
)

Member Function Documentation

◆ module()

def module (   self)
:return: the actual repository containing the submodules

Reimplemented from Submodule.

◆ update()

def update (   self,
  previous_commit = None,
  recursive = True,
  force_remove = False,
  init = True,
  to_latest_revision = False,
  progress = None,
  dry_run = False,
  force_reset = False,
  keep_going = False 
)
Update the submodules of this repository to the current HEAD commit.
This method behaves smartly by determining changes of the path of a submodules
repository, next to changes to the to-be-checked-out commit or the branch to be
checked out. This works if the submodules ID does not change.
Additionally it will detect addition and removal of submodules, which will be handled
gracefully.

:param previous_commit: If set to a commit'ish, the commit we should use
    as the previous commit the HEAD pointed to before it was set to the commit it points to now.
    If None, it defaults to HEAD@{1} otherwise
:param recursive: if True, the children of submodules will be updated as well
    using the same technique
:param force_remove: If submodules have been deleted, they will be forcibly removed.
    Otherwise the update may fail if a submodule's repository cannot be deleted as
    changes have been made to it (see Submodule.update() for more information)
:param init: If we encounter a new module which would need to be initialized, then do it.
:param to_latest_revision: If True, instead of checking out the revision pointed to
    by this submodule's sha, the checked out tracking branch will be merged with the
    latest remote branch fetched from the repository's origin.
    Unless force_reset is specified, a local tracking branch will never be reset into its past, therefore
    the remote branch must be in the future for this to have an effect.
:param force_reset: if True, submodules may checkout or reset their branch even if the repository has
    pending changes that would be overwritten, or if the local tracking branch is in the future of the
    remote tracking branch and would be reset into its past.
:param progress: RootUpdateProgress instance or None if no progress should be sent
:param dry_run: if True, operations will not actually be performed. Progress messages
    will change accordingly to indicate the WOULD DO state of the operation.
:param keep_going: if True, we will ignore but log all errors, and keep going recursively.
    Unless dry_run is set as well, keep_going could cause subsequent/inherited errors you wouldn't see
    otherwise.
    In conjunction with dry_run, it can be useful to anticipate all errors when updating submodules
:return: self

Field Documentation

◆ k_root_name

k_root_name
static

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