ScriptSvnDataInterfaces

class

ScriptSvnDataInterfaces.

SvnObjectId

Bases: object

Opaque handle interface. Does not contain any user-adressable data.

class

ScriptSvnDataInterfaces.

SvnRevision

Bases: object

Encapsulates a subversion revision.

property

RevisionType

Return type

SvnRevisionType

property

Revision

Return type

int

property

Time

Return type

DateTime

property

IsExplicit

Return type

bool

property

RequiresWorkingCopy

Return type

bool

property

DisplayString

Return type

str

Equals

other

Parameters

other (SvnRevision) –

Return type

bool

class

ScriptSvnDataInterfaces.

SvnRevisionRange

Bases: object

A range between two SvnRevisions.

property

StartRevision

Return type

property

EndRevision

Return type

class

ScriptSvnDataInterfaces.

SvnLogInfo

Bases: object

Log information for subversion repository.

property

LogOrigin

Return type

Uri

property

Author

Return type

str

property

LogMessage

Return type

str

property

Revision

Return type

int

property

Time

Return type

DateTime

property

ChangedPaths

Return type

property

RevisionProperties

Return type

class

ScriptSvnDataInterfaces.

SvnChangeItem

Bases: object

Item describing a single change in a svn log info instance.

property

Path

Return type

str

property

RepositoryPath

Return type

Uri

property

Action

Return type

SvnChangeAction

property

CopyFromPath

Return type

str

property

CopyFromRevision

Return type

int

class

ScriptSvnDataInterfaces.

SvnStatusInfo

Bases: object

Subversion status information.

property

ObjectInfo

Return type

property

Url

Return type

Uri

property

WorkingCopyInfo

This property is not implemented any more.

Return type

[Obsolete(“This method is deprecated since SharpSVN 1.7, use SvnStatusInfo2 and GetInfo() instead.”)]

property

LocalContentStatus

Content status in working copy

Return type

SvnStatus

property

LocalPropertyStatus

Property status in working copy

Return type

SvnStatus

property

LocalCopied

Gets a boolean indicating whether the file is copied in the working copy

Return type

bool

property

LocalLocked

Return type

bool

[Obsolete(“Use ISvnStatusInfo2.Wedged”)]

property

PristineContentStatus

Gets the pristine content status.

Return type

SvnStatus

[Obsolete(“use ‘LocalTextStatus’ instead.”)]

property

PristinePropertyStatus

Gets the pristine property status.

Return type

SvnStatus

[Obsolete(“use ‘LocalPropertyStatus’ instead.”)]

property

RemoteContentStatus

Gets the remote content status.

Return type

SvnStatus

Returns

The remote content status.

property

RemotePropertyStatus

Return type

SvnStatus

property

RemoteLockInfo

Return type

property

RemoteUpdateCommitAuthor

Out of Date: Gets the author of the OutOfDate commit

Return type

str

property

RemoteUpdateCommitTime

Out of Date: Last commit date of the item

Return type

DateTime

property

RemoteUpdateRevision

Out of Date: Last commit version of the item

Return type

int

property

External

Gets a value indicating whether this SvnStatusInfo is for a FileExternal object.

Return type

bool

Returns

True if external; otherwise False.

property

RemoteUpdated

Gets a value indicating whether this instance is updated remote.This also indicates that the RemoteUpdate* Properties are set.

Return type

bool

Returns

True if this instance is remote updated; otherwise False.

property

Switched

Gets a boolean indicating whether the file is switched in the working copy

Return type

bool

property

TreeConflict

Return type

[Obsolete(“This is always null with SharpSVN 1.7. Use .IsConflicted and ISvnProjectServices2.GetInfo to get that information.”)]

property

NodeKind

Return type

SvnNodeKind

property

Conflicted

Return type

bool

property

HasLocalPropertyChanges

Return type

bool

property

ChangeList

Gets the change list this item is part of, or None if it is not part of a change list.

Return type

str

Returns

The change list.

property

FullPath

Gets the full path of the item.

Return type

str

property

LastChangeAuthor

Return type

str

property

LastChangeRevision

Return type

int

property

LastChangeTime

Return type

DateTime

property

HasLockInfoInWorkingCopy

Gets a value indicating whether this instance is locked in subversion.

Return type

bool

Returns

True if this instance is locked in subversion; otherwise False.

property

LocalLockInfo

Gets the local locking information.

Return type

property

LocalNodeStatus

Gets the local node status (combination of restructuring operations, text and property status.)

Return type

SvnStatus

property

LocalTextStatus

Gets the status of the text/content of the node

Return type

SvnStatus

property

Modified

Return type

bool

property

RemoteNodeStatus

Return type

SvnStatus

property

RemoteTextStatus

Return type

SvnStatus

property

RemoteUpdateNodeKind

Gets the kind of the remote update node, if the node is out of date. Set to the node kind of the youngest commit, or #svn_node_noneif not out of date.

Return type

SvnNodeKind

Returns

The kind of the out of date node.

property

RepositoryId

Gets the repository id as Guid.

Return type

Guid

property

RepositoryIdValue

Gets the repository id value.

Return type

str

property

RepositoryRoot

Return type

Uri

property

Revision

Return type

long

property

Versioned

Return type

bool

property

Wedged

Gets a value indicating whether this working copy is locked (e. G. byanother client operating concurrently, or by some aborted SVNoperation). You can use Cleanup to unlock stale locks.

Return type

bool

Returns

True if wedged; otherwise False.

property

ItemType

Gets the type of the object id.

Return type

SvnItemType

Returns

The type of the object id.

property

MovedFrom

Gets the abspath this node was moved from.

Return type

str

Returns

The moved from.

property

MovedTo

Gets the moved to.

Return type

str

Returns

The moved to.

property

IsFileExternal

Gets a boolean indicating whether the node is a file external

Return type

bool

property

Depth

Gets the depth of the node as recorded in the working copy (relevant for partial checkouts).(SvnDepth.Unknown for files or when no depth is recorded)

Return type

SvnDepth

Returns

The depth.

property

FileLength

The length of the file currently in the working copy, matching the name of this node. -1 if there is no such file.

Return type

long

class

ScriptSvnDataInterfaces.

HasItemType

Bases: object

Interface common to all objects which provide an ObjectIdType.

property

ItemType

Gets the type of the object id.

Return type

SvnItemType

Returns

The type of the object id.

class

ScriptSvnDataInterfaces.

SvnInfo

Bases: object

property

ObjectId

Gets the SvnObjectId the info is for.

Return type

property

ObjectInfo

The ISvnObjectInfo for the Id.

Return type

property

Url

Gets the URL.

Return type

Uri

property

Revision

Gets the queried revision.

Return type

property

NodeKind

Gets the kind of the node.

Return type

SvnNodeKind

Returns

The kind of the node.

property

RepositoryRoot

Gets the repository root.

Return type

Uri

property

RepositoryId

Gets the repository id, or Guid.Empty if not available.

Return type

Guid

property

LastChangeRevision

Gets the revision in which the subtree of the node had its last change.

Return type

property

LastChangeTime

Gets the last change time.

Return type

DateTime

property

LastChangeAuthor

Gets the last change author.

Return type

str

property

LockInfo

Gets the lock information.

Return type

property

hasLocalInfo

Gets a value indicating whether this instance has local info.

Return type

bool

Returns

True if this instance has local info; otherwise False.

property

Schedule

Gets the schedule.

Return type

SvnSchedule

property

CopyFromUri

Gets the copy from URI.

Return type

Uri

property

CopyFromRevision

Gets the copy from revision.

Return type

property

ContentTime

Gets the content time.

Return type

DateTime

property

Checksum

Gets the SHA1 checksum.

Return type

str

property

Conflicts

Gets information about the conflicts affecting the file.

Return type

property

Depth

Return type

SvnDepth

Returns

the depth.

property

ChangeList

Gets the change list.

Return type

str

property

WorkingCopySize

Gets the size of the file in the working copy.

Return type

long

Returns

The size of the the file in working copy.

property

RepositorySize

Gets the size of the file in the repository.

Return type

long

Returns

The size of the the file in repository.

property

TreeConflict

Gets the tree conflict information.

Return type

property

Conflicted

Gets a value indicating whether this SvnInfo is conflicted.

Return type

bool

Returns

True if conflicted; otherwise False.

property

FullPath

Gets the full path of the item in the working copy.

Return type

str

property

ItemType

Gets the type of the object id.

Return type

SvnItemType

Returns

The type of the object id.

property

WorkingCopyRoot

Gets the local absolute path of the working copy root.

Return type

str

Returns

The working copy root.

property

MovedFrom

Gets the abspath this node was moved from, or null if it was not moved.

Return type

str

Returns

The moved from.

property

MovedTo

Gets abspath this node was moved to, or null if it was not moved.

Return type

str

Returns

The moved to.

class

ScriptSvnDataInterfaces.

SvnWorkingCopyInfo

Bases: object

Subversion working copy information.

[Obsolete(“This interface is deprecated since SharpSVN 1.7, use SvnStatusInfo2 and GetInfo() instead.”)]

property

Revision

Return type

long

property

Schedule

Return type

SvnSchedule

[Obsolete(“Obsoleded by SVN 1.7. Use ISvnStatusInfo2.LocalNodeStatus.”)]

property

RepositoryId

Return type

str

property

RepositoryUrl

Return type

Uri

property

Url

Return type

Uri

property

ContentChangeTime

Return type

DateTime

property

Checksum

Return type

str

property

WorkingCopySize

Return type

long

property

LastChangeAuthor

Return type

str

property

LastChangeRevision

Return type

long

property

LastChangeTime

Return type

DateTime

property

HasProperties

Return type

bool

property

HasPropertyChanges

Return type

bool

property

Absent

Return type

bool

property

Copied

Return type

bool

property

Deleted

Return type

bool

property

Incomplete

Return type

bool

property

KeepLocal

Return type

bool

property

LockOwner

Return type

str

property

LockComment

Return type

str

property

LockToken

Return type

str

property

LockTime

Return type

DateTime

property

FileExternalPath

Return type

str

property

FileExternalRevision

Return type

property

FileExternalOperationalRevision

Return type

property

CopiedFromUrl

Return type

Uri

property

CopiedFromRevision

Return type

long

property

Changelist

Return type

str

property

ConflictWorkFile

Return type

str

property

ConflictNewFile

Return type

str

property

ConflictOldFile

Return type

str

property

PropertyRejectFile

Return type

str

class

ScriptSvnDataInterfaces.

SvnConflictData

Bases: object

Subversion conflict data information.

property

PropertyName

Gets the name of the property.

Return type

str

Returns

The name of the property.

property

BaseFile

Gets the base file, the common ancestor of the two to-be-merged files.

Return type

str

property

MergedFile

Gets the merged file. (This is most likely null in our case as we use binary files.)

Return type

str

property

MyFile

Gets my file (The local version of the file).

Return type

str

property

TheirFile

Gets their file (The incoming version of the file).

Return type

str

property

Operation

Gets the operation which caused the conflict (currently only set for Tree Conflicts).

Return type

SvnOperation

property

ConflictAction

Gets the conflict action.

Return type

SvnConlictAction

property

ConflictReason

Gets the conflict reason.

Return type

SvnConlictReason

property

ConflictType

Gets the type of the conflict.

Return type

SvnConlictType

Returns

The type of the conflict.

property

LeftSource

Gets the left source.

Return type

property

RightSource

Gets the right source.

Return type

property

IsBinary

Gets a value indicating whether svn thinks that this instance is binary.

Return type

bool

Returns

True if this instance is binary; otherwise False.

property

NodeKind

Gets the kind of the node.

Return type

SvnNodeKind

Returns

The kind of the node.

property

ParentInfo

Gets a back reference to the ISvnInfo object which carries this conflict.

Return type

property

MetaObjectPropertyGuid

If ISvnConflictData.ConflictType is SvnConflictType.Property, this returns the TypeGuidAttribute of the ObjectProperty type.

Return type

Guid

property

BaseObject

Gets the base object, the common ancestor of the two to-be-merged objects.

Return type

object

property

MergedObject

Gets the merged object. (This is most likely null in our case as we use binary files.)

Return type

object

property

MyObject

Gets my object (The local version of the object).

Return type

object

property

TheirObject

Gets their object (The incoming version of the file).

Return type

object

property

WorkingObject

Gets the working copy object (The existing working copy version of the file).

Return type

object

property

MimeType

Gets the Mime type SVN thinks that this object has. May be null.

Return type

str

Returns

The type of the MIME.

property

FullPath

Gets the full path of the conflicting node.

Return type

str

property

Name

Gets the file name.

Return type

str

Returns

The name.

property

PropertyRejectFile

For property conflicts, the absolute path to the .prej file.

Return type

str

Returns

The absolute path of the property reject file

class

ScriptSvnDataInterfaces.

SvnObjectInfo

Bases: object

Common subversion object information.

property

Node

Gets the node.

Return type

PSNode

property

ProjectHandle

Gets the project handle.

Return type

nt

property

ObjectId

Gets the object id.

Return type

property

DisplayString

Gets the display string for the node, or null if none.

Return type

str

IsForSameLocation

other

Determines whether two SvnObjectInfo instances point to the same working copy location.

Parameters

other (SvnObjectId) – The other.

Return type

bool

Returns

True if is at same location as the specified other SvnObjectInfo; otherwise False.

property

ItemType

Gets the type of the object id.

Return type

SvnItemType

Returns

The type of the object id.

class

ScriptSvnDataInterfaces.

SvnMetaProfileInfo

Bases: object

Extended object information for the Meta profile file. This is read-only here, the profile is synchronized with the object manager storage profile.

property

ProfileName

Gets the name of the profile.

Return type

str

Returns

The name of the profile.

property

Profile

Gets the profile.

Return type

class

ScriptSvnDataInterfaces.

SvnVirtualPSNode

Bases: object

Marker interface for “virtual” PSNodes made up by the SVNIntegration plugin on several occasions. For example, one of those is is delivered as part of the ISvnObjectInfo for deleted locations in the working copy. They are also used to represent remote objects when getting remote information, and to represent not yet loaded objects when searching for a location for external directories.

If you create your own instances of SvnVirtualPSNode or subclasses and pass them to the subversion integration plugin, the result is undefined.

property

ObjectProperties

Gets the object properties.

Return type

list(ObjectProperty)

GetProperty

Gets a specific property.

Parameters

guid (Guid) – The GUID.

Return type

ObjectProperty

class

ScriptSvnDataInterfaces.

SvnDeletedPSNode

Bases: object

Marker interface for deleted PS Nodes. This are Nodes which were deleted from the project, but still have an existing working copy location due to the deletion not being committed yet.

class

ScriptSvnDataInterfaces.

SvnRemotePSNode

Bases: object

Marker interface for remote PS Nodes. They return -1 on their project handle.

property

Url

Gets the URL.

Return type

Uri

property

Revision

Gets the revision.

Return type

HasValidNodeUrl

Gets a value indicating whether this instance is valid node.This is currently done by checking for the svn metadata being presenton the server at the given revision.

Return type

bool

Returns

True if this instance is valid node; otherwise False.

property

ObjectId

Gets the object id.

Return type

class

ScriptSvnDataInterfaces.

SvnPropertyList

Bases: object

A container for all SVN properties of a given object.

property

ObjectInfo

Return type

property

Properties

Return type

Dictionary[str, SvnPropertyValue]

class

ScriptSvnDataInterfaces.

SvnPropertyValue

Bases: object

A subversion property value.

property

RawValue

Gets the raw value for binary properties.

Return type

list(byte)

property

StringValue

Gets the string value for text properties.

Return type

str

class

ScriptSvnDataInterfaces.

SvnLockInfo

Bases: object

Subversion locking information.

property

ObjectInfo

Return type

property

Owner

Return type

str

property

Token

Return type

str

property

Comment

Return type

str

property

IsRawNetworkComment

Return type

bool

property

CreationTime

Return type

DateTime

property

ExpirationTime

Return type

DateTime

class

ScriptSvnDataInterfaces.

SvnMergeRange

Bases: object

Instances of this interface represent a merge range.

property

Start

Return type

long

property

End

Return type

long

property

Inheritable

Return type

bool

class

ScriptSvnDataInterfaces.

SvnNotify

Bases: object

Subversion notification information.

property

CommandType

Return type

SvnCommandType

property

Action

Return type

SvnNotifyAction

property

ObjectInfo

Return type

property

Url

Return type

Uri

property

PropertyName

Return type

str

property

ContentState

Return type

:clsdd:`SvnNotifyState`

property

PropertyState

Return type

SvnNotifyState

property

LockInfo

Return type

property

LockState

Return type

SvnLockState

property

Revision

Return type

long

property

OldRevision

Return type

long

property

MergeRange

Return type

property

RevisionProperties

Return type

Dictionary[str, SvnPropertyValue]

property

ChangelistName

Return type

str

property

NodeKind

Return type

SvnNodeKind

property

Error

Return type

SvnException

class

ScriptSvnDataInterfaces.

SvnConflictSource

Bases: object

property

Url

Return type

Uri

property

RepositoryPathUrl

Gets the relative url inside the repository.

Return type

Uri

property

RepositoryRootUrl

Return type

Uri

property

Revision

Return type

long

property

NodeKind

Return type

SvnNodeKind

class

ScriptSvnDataInterfaces.

SvnDifference

Bases: object

property

ObjectInfo

Return type

property

DiffKind

Return type

SvnDiffKind

property

PropertiesChanged

Return type

bool

class

ScriptSvnDataInterfaces.

SvnDirEntry

Bases: object

property

Author

Return type

str

property

FileSize

Return type

long

property

HasProperties

Return type

bool

property

NodeKind

Return type

SvnNodeKind

property

Revision

Return type

property

Time

Return type

DateTime

property

BasePath

Return type

str

property

BaseUrl

Return type

Uri

property

Lock

Return type

property

Name

Return type

str

property

Path

Return type

str

property

RepositoryRoot

Return type

Uri

property

Url

Return type

Uri

property

Node

Return type

property

Info

Return type

property

ObjectId

Return type

class

ScriptSvnDataInterfaces.

SvnWorkingCopyVersionSummary

Bases: object

The version summary of a svn working copy (similar to svnversion.exe).

property

MinVersion

Gets the min version.

Return type

int

property

MaxVersion

Gets the max version.

Return type

int

property

IncompleteWorkingCopy

Gets a value indicating whether [incomplete working copy].

Return type

bool

Returns

True if [incomplete working copy]; otherwise False.

property

Modified

Gets a value indicating whether this SvnWorkingCopyVersionSummary is modified.

Return type

bool

Returns

True if modified; otherwise False.

property

Switched

Gets a value indicating whether this SvnWorkingCopyVersionSummary is switched.

Return type

bool

Returns

True if switched; otherwise False.

property

CleanVersion

Gets a value indicating whetherthe version is clean (MINREVISION == MAXREVISION, not incomplete, not modified, not switched)

Return type

bool

Returns

True if [clean version]; otherwise False.

property

VersionSummary

Gets the version summary.

Return type

str

property

LastChangeUtc

Gets the time of the last change in UTC.

Return type

DateTime

Returns

The time of the last change in UTC.

property

LastChangeAuthor

Gets author of the last change.

Return type

str

Returns

The author of the last change.

property

Disconnected

Gets or sets the disconnected status.

Return type

bool

property

Disconneted

Gets or sets the disconnected status.

Return type

bool

class

ScriptSvnDataInterfaces.

SvnUrlTarget

Bases: object

A helper interface to encapsulate an Url and an operational revision (aka “peg revision”). The implementation returned by ISvnCommonServices2.CreateSvnTarget is hashable and thus suitable as a dictionary key.

property

Url

Gets the URL.

Return type

Uri

property

Revision

Gets the revision.

Return type