Class: DurableHuggingfaceHub::Types::CommitInfo

Inherits:
Struct
  • Object
show all
Includes:
Loadable
Defined in:
lib/durable_huggingface_hub/types/commit_info.rb

Overview

Information about a Git commit in a HuggingFace Hub repository.

Examples:

Creating a CommitInfo from API response

commit_info = CommitInfo.from_hash({
  "oid" => "a1b2c3d4e5f6...",
  "title" => "Update model weights",
  "message" => "Update model weights\n\nImproved accuracy",
  "date" => "2024-01-15T10:30:00Z"
})

Accessing commit information

commit_info.oid    # => "a1b2c3d4e5f6..."
commit_info.title  # => "Update model weights"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#authors ⇒ Array<String>? (readonly)

Returns Commit authors.

Returns:

  • (Array<String>, nil) —

    Commit authors



41
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 41

attribute :authors, Types::OptionalStringArray.default(nil)

#commit_message ⇒ String? (readonly)

Returns Alias for message (API compatibility).

Returns:

  • (String, nil) —

    Alias for message (API compatibility)



49
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 49

attribute :commit_message, Types::OptionalString.default(nil)

#commit_url ⇒ String? (readonly)

Returns URL to view the commit.

Returns:

  • (String, nil) —

    URL to view the commit



45
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 45

attribute :commit_url, Types::OptionalString.default(nil)

#date ⇒ Time? (readonly)

Returns Commit timestamp.

Returns:

  • (Time, nil) —

    Commit timestamp



37
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 37

attribute :date, Types::OptionalTimestamp.default(nil)

#message ⇒ String? (readonly)

Returns Full commit message.

Returns:

  • (String, nil) —

    Full commit message



33
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 33

attribute :message, Types::OptionalString.default(nil)

#oid ⇒ String (readonly)

Returns Commit OID (Git SHA).

Returns:

  • (String) —

    Commit OID (Git SHA)



25
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 25

attribute :oid, Types::String

#title ⇒ String (readonly)

Returns Commit title (first line of message).

Returns:

  • (String) —

    Commit title (first line of message)



29
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 29

attribute :title, Types::String

Instance Method Details

#full_message ⇒ String?

Returns the commit message (preferring message over commit_message).

Returns:

  • (String, nil) —

    Commit message



61
62
63
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 61

def full_message
  message || commit_message
end

#inspect ⇒ String

Returns a detailed inspection string.

Returns:

  • (String) —

    Inspection string



75
76
77
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 75

def inspect
  "#<#{self.class.name} oid=#{short_oid.inspect} title=#{title[0, 50].inspect}>"
end

#short_oid ⇒ String

Returns the short OID (first 7 characters).

Returns:

  • (String) —

    Short OID



54
55
56
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 54

def short_oid
  oid[0, 7]
end

#to_s ⇒ String

Returns a short description of the commit.

Returns:

  • (String) —

    Description string



68
69
70
 
# File 'lib/durable_huggingface_hub/types/commit_info.rb', line 68

def to_s
  "#{short_oid}: #{title}"
end