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

Data Structures

class  Index
 

Public Member Functions

def diff (self, other=Index, paths=None, create_patch=False, **kwargs)
 

Detailed Description

Common interface for all object that can be diffed against another object of compatible type.

:note:
    Subclasses require a repo member as it is the case for Object instances, for practical
    reasons we do not derive from Object.

Member Function Documentation

◆ diff()

def diff (   self,
  other = Index,
  paths = None,
  create_patch = False,
**  kwargs 
)
Creates diffs between two items being trees, trees and index or an
index and the working tree. It will detect renames automatically.

:param other:
    Is the item to compare us with.
    If None, we will be compared to the working tree.
    If Treeish, it will be compared against the respective tree
    If Index ( type ), it will be compared against the index.
    If git.NULL_TREE, it will compare against the empty tree.
    It defaults to Index to assure the method will not by-default fail
    on bare repositories.

:param paths:
    is a list of paths or a single path to limit the diff to.
    It will only include at least one of the given path or paths.

:param create_patch:
    If True, the returned Diff contains a detailed patch that if applied
    makes the self to other. Patches are somewhat costly as blobs have to be read
    and diffed.

:param kwargs:
    Additional arguments passed to git-diff, such as
    R=True to swap both sides of the diff.

:return: git.DiffIndex

:note:
    On a bare repository, 'other' needs to be provided as Index or as
    as Tree/Commit, or a git command error will occur

Reimplemented in IndexFile.


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