ScriptSvnEventServices

class ScriptSvnEventServices.SvnEventServices

Bases: object

Contains all Svn functionality which is bound to a working copy / versioned project. You get this instance via SvnIntegration.EventServices”.

PushAuthenticationHandler(handler)

Pushes the authentication handler onto the handler stack.

Parameters:

handler (SvnAuthenticationEventArgs) – The handler.

PopAuthenticationHandler()

Pops the authentication handler from the handler stack.

PushCommitRecursionConflictHandler(handler)

Pushes the commit conflict handler.

Parameters:

handler (SvnSelectionRecursionConflictEventArgs) – The handler.

PopCommitRecursionConflictHandler()

Pops the commit conflict handler.

PushRevertRecursionConflictHandler(handler)

Pushes the revert conflict handler.

Parameters:

handler (SvnSelectionRecursionConflictEventArgs) – The handler.

PopRevertRecursionConflictHandler()

Pops the revert conflict handler.

PushSelectionHookConflictHandler(handler)

Pushes the commit conflict handler.

Parameters:

handler (SvnSelectionHookConflictEventArgs) – The handler.

PopSelectionHookConflictHandler()

Pops the commit conflict handler.

PushCommitOrphanedChildHandler(handler)

Pushes the commit orphaned child handler.

Parameters:

handler (SvnSelectionOrphanedChildEventArgs) – The handler.

PopCommitOrphanedChildHandler()

Pops the commit orphaned child handler.

PushRevertOrphanedChildHandler(handler)

Pushes the revert orphaned child handler.

Parameters:

handler (SvnSelectionOrphanedChildEventArgs) – The handler.

PopRevertOrphanedChildHandler()

Pops the revert orphaned child handler.

PushRollbackRequiredHandler(handler)

Pushes the rollback required handler.

Parameters:

handler (SvnRollbackRequiredEventArgs) – The handler.

PopRollbackRequiredHandler()

Pops the rollback required handler.

PushSelectionCrossesExternalHandler(handler)

Pushes the selection crosses external handler.

Parameters:

handler (SvnSelectionCrossesExternalEventArgs) – The handler.

PopSelectionCrossesExternalHandler()

Pops the selection crosses external handler.

PushProjectAlreadyExistsHandler(handler)

Pushes the project already exists handler. This is called on checkout when the specified project already exists. Dont forget to set both handled and cancel according to your needs.

Parameters:

handler (SvnProjectAlreadyExistsEventArgs) – The handler.

PopProjectAlreadyExistsHandler()

Pops the project already exists handler.

property StatusChanged

Occurs whenever the SVN status of a node changes.

Return type:

SvnStatusChangedEventArgs

property ConsistencyChecking

Occurs when the Check Consistency function is called. External modules communicating with the subversion integration can add their own checks there.

Return type:

SvnConcistencyCheckArgs

PushWorkingCopyUpgradeNeededHandler(handler)

Pushes the working copy upgrade needed handler. This event is triggered when an upgrade of a working copy to a newer format is needed. Dont forget to set both handled and cancel according to your needs.

Parameters:

handler (SvnWorkingCopyUpgradeNeededEventArgs) – The handler.

PopWorkingCopyUpgradeNeededHandler()

Pops the working copy upgrade needed handler.

property RemoteCacheClearing

Occurs when a remote cache clearing was requested. This event can be used by other plugins to hook into that event. see SvnIntegration.ClearRemoteCaches

Return type:

EventArgs

PushArchiverMessageHandler(handler)

Pushes the archive writer message handler. This event is triggered on any messages by the archive writer reader or when we serialize objects out to the working copy. Usually, those events are just to be logged, as the same warnings are already issued by the ObjectManager.

Parameters:

handler (SvnArchiverEventArgs) – The handler.

PopArchiverMessageHandler()

Pops the archive writer message handler.

PushArchiverPromptHandler(handler)

This event is triggered when we get unserializable data from the Archive reader, and prompt the user how to proceed.

Parameters:

handler (SvnArchiverPromptEventArgs) – The handler.

PopArchiverPromptHandler()

Pops the profile changed message handler.

PushConflictResolutionQueryHandler(handler)

This event is triggered when we get unserializable data from the Archive reader, and prompt the user how to proceed.

Parameters:

handler (SvnConflictResolutionQueryEventArgs) – The handler.

PopConflictResolutionQueryHandler()

Pops the profile changeded message handler.

PushDefaultConflictHandlerUserQuery(handler)

This event is raised whenever the default conflict resolver has conflicts within a file, and the “MergeAndQuery” option is set.

Parameters:

handler (SvnDefaultConfictHandlerUserQueryEventArgs) – The handler.

PopDefaultConflictHandlerUserQuery()

Pops the MergeAndQuery message handler.

PushNameCollisionUserQueryHandler(handler)

This event is raised whenever there are colliding objects.

Parameters:

handler (SvnNameCollisionUserQueryEventArgs) – The handler.

PopNameCollisionUserQueryHandler()

Pops the collision handler.

PushContactServerInOfflineModeQueryHandler(handler)

This event is raised whenever there we need to contact the server in offline mode.

Parameters:

handler (SvnContactServerInOfflineModeEventArgs) – The handler.

PopContactServerInOfflineModeQueryHandler()

Pops the collision handler.

PushAutoLockFailedHandler(handler)

This event is raised whenever there we need to contact the server in offline mode.

Parameters:

handler (SvnAutoLockFailedEventArgs) – The handler.

PopAutoLockFailedHandler()

Pops the collision handler.

class ScriptSvnEventServices.SvnSelectionRecursionConflictEventArgs

Bases: HandledCancelEventArgs

This event is used when operations like commit or revert need to resolve conflicts in their processing of recursive directories. e. G. commit of deleted directories or revert of added directories needs recursive processing.

property ObjectRequiringRecursiveProcessing

rtype: SvnObjectInfo

property ObjectPreventingRecursiveProcessing

rtype: SvnObjectInfo

class ScriptSvnEventServices.SvnSelectionHookConflictEventArgs

Bases: HandledCancelEventArgs

This event is used when the selection verification hooks have conflicting requirements.

property Action

The action which caused the conflict.

Return type:

SvnSelectionVerificationAction

ConflictingCandidate()

Gets the conflicting candidate, this is the object which the first hook wants to select, and the second hook wants to deselect.

Return type:

SvnObjectId

property RequiringReason

This is the reason why the first hook wants to select the ConflictingCandidate.

Return type:

str

ObjectRequiringSelection()

This is the object causing the first hook to select the ConflictingCandidate.

Return type:

SvnObjectId

PreventingReasion()

This is the reason why the second hook wants to deselect the ConflictingCandidate.

Return type:

str

ObjectPreventingSelection()

This is the object causing the second hook to deselect the ConflictingCandidate.

Return type:

SvnObjectId

class ScriptSvnEventServices.SvnSelectionCrossesExternalEventArgs

Bases: HandledEventArgs

This event is used when operations like commit note that they cannot proceede because they cross external boundaries.

property FirstObject
Return type:

SvnObjectInfo

property SecondObject
Return type:

SvnObjectInfo

property SplitPossible

Gets a value indicating whether it is possible to split the commit into several independent commit operations.

Return type:

bool

Returns:

True if a split is possible; otherwise, False.

property SplitWanted

Gets or sets a value indicating whether the user wants to split the commit into several independent commit operations.

Return type:

bool

Returns:

True if a split is wanted; otherwise, False.

class ScriptSvnEventServices.SvnSelectionOrphanedChildEventArgs

Bases: HandledEventArgs

This event args are used when the selection for a revert includes a deleted node with a parent node which is also deleted, but is not itsself scheduled for reversion.

property OrphanedChild
Return type:

SvnObjectInfo

class ScriptSvnEventServices.SvnRollbackRequiredEventArgs

Bases: HandledEventArgs

property ProjectHandle
Return type:

int

property Reasons
Return type:

list[Exception]

class ScriptSvnEventServices.SvnStatusChangedEventArgs

Bases: EventArgs

This event is used when the SVN status of some objects changes.

control of that object, it does not necessarily correspond to existence in the object manager. Examples for this are importing of objects into a repository and disconnect.

The list of guids may also contain the empty guid, which means that the project root (“virtual” parent of the top level nodes) is affected.

Note that the same object can be in all three of those lists if several actions happened in the same transaction.

property ProjectHandle

Gets the project handle.

Return type:

int

property ChangeType

Gets the type of the change.

Return type:

SvnStatusChangeType

Returns:

The type of the change.

property RemovedObjects

Gets the removed objects.

Return type:

list[Guid]

property ChangedObjects

Gets the changed objects.

Return type:

list[Guid]

property AddedObjects

Gets the added objects.

Return type:

list[Guid]

class ScriptSvnEventServices.SvnConcistencyCheckArgs

Bases: EventArgs

property Reporter
Return type:

SvnCheckReporter

property ProjectHandle
Return type:

int

property IsVersioned

Gets a value indicating whether the currently checked project is regarded as versioned by the subversion plugin. This allows subscribers to check whether they have stale state information for unversioned projects, or missing state information for versioned (non-promary) projects.

Return type:

bool

Returns:

True if this instance is versioned; otherwise, False.

class ScriptSvnEventServices.SvnUISelectionHookEventArgs

Bases: CancelEventArgs

This event args are used by the SvnUIServices to process selection extension or inversion.

RequestSelection(obj, requiringObject, stReason)

Requests the selection of the specified object.

Parameters:
  • obj (SvnObjectId) – The obj.

  • requiringObject (SvnObjectId) – The requiring object.

  • stReason (str) – The human readable reason.

RequestDeselection(obj, requiringObject, stReason)

Requests the deselection of the specified obj.

Parameters:
  • obj (SvnObjectId) – The obj.

  • requiringObject (SvnObjectId) – The requiring object.

  • stReason (str) – The human readable reason.

UserWantsToSelect()

Gets the list of objects the user wants to select.

Return type:

list[SvnObjectId]

property UserWantsToDeSelect

Gets the list of objects the user wants to deselect.

Return type:

SvnObjectId

property SelectedBeforeUserChange

Gets the objects which were selected before the user clicked.

Return type:

list[SvnObjectId]

property HooksWantToSelect

Gets the list of objects any previous hook wants to select.

Return type:

list[SvnObjectId]

property HooksWantToDeselect

Gets the list of objects any previous hook wants to deselect.

Return type:

list[SvnObjectId]

GetRequiringObjectForSelection(selection)

Gets the requiring object causing the selection request.

Parameters:

selection (SvnObjectId) – The selection.

Return type:

SvnObjectId

GetRequiringObjectForDeSelection(selection)

Gets the requiring object causing the deselection request.

Parameters:

selection (SvnObjectId) – The selection.

Return type:

SvnObjectId

GetReasonForSelection(selection)

Gets the reason for the selection request.

Parameters:

selection (SvnObjectId) – The selection.

Return type:

str

GetReasonForDeSelection(selection)

Gets the reason for the deselection request.

Parameters:

selection (SvnObjectId) – The selection.

Return type:

str

property ChangeCount

Gets the number of change requests made up to now.

Return type:

int

class ScriptSvnEventServices.SvnProjectAlreadyExistsEventArgs

Bases: HandledCancelEventArgs

This event is used when operations creating a new project (like checkout) encounter an already existing project file.

class ScriptSvnEventServices.SvnWorkingCopyUpgradeNeededEventArgs

Bases: HandledCancelEventArgs

This event is triggered when the activation of subversion for a project requires the upgrading of a working copy.

class ScriptSvnEventServices.HandledCancelEventArgs

Bases: CancelEventArgs

Common base class for events which are Cancellable and have a notion whether they’ve been handled.

class ScriptSvnEventServices.SvnArchiverEventArgs

Bases: HandledEventArgs

Abstract base class for the archiver message events.

property ProjectHandle

Gets the project for which the event was triggered. This may be set to -1 if the event was triggered by a remote access with no project.

Return type:

int

Returns:

The node.

property ObjectGuid

Gets the object guid for which the event was triggered. This may be set to Guid.Empty if the event was triggered by a remote access with no project, or by an object which is not (yet) known to the object manager.

Return type:

Guid

Returns:

The node.

property EventType

Gets or sets the type of the archive writer event.

Return type:

SvnArchiveEventType

Returns:

The type of the archive writer event.

class ScriptSvnEventServices.SvnArchiverPromptEventArgs

Bases: SvnArchiverEventArgs

Abstract base class for the archiver events when an Answer from the User is needed.

property AllowedReactions

Gets the allowed reactions in the current situation. Iterating returns them ordered by “impact” of the reaction.

Return type:

list[SvnArchiveErrorReaction, str]

property Reaction

Gets or sets the reaction.

Return type:

SvnArchiveErrorReaction

Returns:

The reaction, this is set to the default reaction for the current situation before the

event is raised.

the default for the next handler, you need to reset HandledEventArgs.Handled.

class ScriptSvnEventServices.SvnConflictResolutionQueryEventArgs

Bases: EventArgs

This event is used when operations like commit or revert need to resolve conflicts in their processing of recursive directories. e. G. commit of deleted directories or revert of added directories needs recursive processing.

property Result
Return type:

SvnConflictResolutionQueryResult

property Info
Return type:

SvnConflictsInfo

Solver()
Return type:

SvnConflictSolver

class ScriptSvnEventServices.SvnDefaultConfictHandlerUserQueryEventArgs

Bases: EventArgs

This event is raised whenever the default conflict resolver has conflicts within a file, and the “MergeAndQuery” option is set.

property Result
Return type:

int

property SupportsConflictMarkers
Return type:

bool

property Description
Return type:

str

class ScriptSvnEventServices.SvnNameCollisionUserQueryEventArgs

Bases: HandledEventArgs

This event is raised whenever some nodes fail to be added during an partial update of the working copy due to name conflicts, and the conflicting nodes are already deleted in the repository.

property Collisions

Gets information about the collisions. (This is read only!):

Return type:

list[SvnNameCollisionData]

property Reaction

Gets or sets a value indicating whether the resolution should be attempted.

Return type:

SvnNameCollisionReaction

Returns:

True if the resolution is to be attempted; otherwise, False.

class ScriptSvnEventServices.SvnContactServerInOfflineModeArgs

Bases: HandledEventArgs

This event is raised whenever some nodes fail to be added during an partial update of the working copy due to name conflicts, and the conflicting nodes are already deleted in the repository.

ExistingObject()

Gets the human readable description of what do do.descr Gets the existing object which collided with the new rejected object.

Return type:

Guid

ExistingObjectFullPath()

Gets the existing object full path in the project structure (convenience function).

Return type:

str

class ScriptSvnEventServices.SvnArchiverSkippedEventInfo

Bases: object

SvnArchiverPromptEventArgs and SvnArchiverEventArgs with SvnArchiverEventArgs.EventType set to SvnArchiveEventType.DataSkipped are extended with this additional information.

property type

Gets or sets the type of the skipped data.

Return type:

Type

Returns:

The type.

SerializableValueName()

Gets or sets the name of the serializable value which was skipped.

Return type:

str

Returns:

The name of the serializable value.

class ScriptSvnEventServices.SvnArchiverMessageEventInfo

Bases: object

SvnArchiverPromptEventArgs and SvnArchiverEventArgs with SvnArchiverEventArgs.EventType set to SvnArchiveEventType.Warning or SvnArchiveEventType.Error are extended with this additional information.

property Message

Gets or sets the message issued by the archive writer.

Return type:

str

Returns:

The message.