класс CSV::Table
Класс CSV::Table — это двумерная структура данных для представления документов CSV. Таблицы позволяют работать с данными по строкам или столбцам, манипулировать данными и даже преобразовывать результаты обратно в CSV, если это необходимо.
Все таблицы, возвращаемые классом CSV, будут созданы из этого класса, если обработка заголовков включена.
Атрибуты
Текущий режим доступа для индексирования и итерации.
Внутренний формат данных, используемый для сравнения на равенство.
Публичные методы класса
# File lib/csv.rb, line 587 def initialize(array_of_rows) @table = array_of_rows @mode = :col_or_row end
Создает новый объект CSV::Table из array_of_rows, которые, как ожидается, являются объектами CSV::Row. Предполагается, что все строки имеют одинаковые заголовки.
Объект CSV::Table поддерживает следующие методы класса `Array` через делегирование:
-
empty?()
-
length()
-
size()
Публичные методы экземпляра
# File lib/csv.rb, line 785
def <<(row_or_array)
if row_or_array.is_a? Array # append Array
@table << Row.new(headers, row_or_array)
else # append Row
@table << row_or_array
end
self # for chaining
end Добавляет новую строку в конец этой таблицы. Вы можете предоставить массив, который будет преобразован в CSV::Row (унаследующий заголовки таблицы), или CSV::Row.
Этот метод возвращает таблицу для цепочки вызовов.
# File lib/csv.rb, line 871 def ==(other) return @table == other.table if other.is_a? CSV::Table @table == other end
Возвращает true если все строки этой таблицы ==() строки other.
# File lib/csv.rb, line 701
def [](index_or_header)
if @mode == :row or # by index
(@mode == :col_or_row and (index_or_header.is_a?(Integer) or index_or_header.is_a?(Range)))
@table[index_or_header]
else # by header
@table.map { |row| row[index_or_header] }
end
end В режиме смешанного доступа по умолчанию этот метод возвращает строки для доступа по индексу и столбцы для доступа по заголовку. Вы можете принудительно установить ассоциацию индексов, предварительно вызвав #by_col!() или #by_row!().
Столбцы возвращаются как массив значений. Изменение этого массива не влияет на таблицу.
# File lib/csv.rb, line 726
def []=(index_or_header, value)
if @mode == :row or # by index
(@mode == :col_or_row and index_or_header.is_a? Integer)
if value.is_a? Array
@table[index_or_header] = Row.new(headers, value)
else
@table[index_or_header] = value
end
else # set column
if value.is_a? Array # multiple values
@table.each_with_index do |row, i|
if row.header_row?
row[index_or_header] = index_or_header
else
row[index_or_header] = value[i]
end
end
else # repeated value
@table.each do |row|
if row.header_row?
row[index_or_header] = index_or_header
else
row[index_or_header] = value
end
end
end
end
end В режиме смешанного доступа по умолчанию этот метод присваивает строки для доступа по индексу и столбцы для доступа по заголовку. Вы можете принудительно установить ассоциацию индексов, предварительно вызвав #by_col!() или #by_row!().
Строкам можно присвоить массив значений (который унаследует заголовки таблицы) или CSV::Row.
Столбцам можно присвоить одно значение, которое будет скопировано в каждую строку столбца, или массив значений. Массивы значений присваиваются строкам сверху вниз в порядке следования строк. Избыточные значения игнорируются, и если массив не содержит значения для каждой строки, дополнительные строки получат nil.
Присваивание существующему столбцу или строке перезаписывает данные. Присваивание новым столбцам создает их в конце таблицы.
# File lib/csv.rb, line 613 def by_col self.class.new(@table.dup).by_col! end
Возвращает дублирующий объект таблицы в режиме столбцов. Это удобно для цепочки вызовов в одном вызове без изменения режима таблицы, но имейте в виду, что этот метод может потреблять значительный объем памяти для больших наборов данных.
Этот метод возвращает дубликат таблицы для цепочки вызовов. Однако не используйте таким образом методы, изменяющие данные (например, []=()), поскольку вы работаете с дубликатом.
# File lib/csv.rb, line 623 def by_col! @mode = :col self end
Переключает режим этой таблицы в режим столбцов. Все вызовы методов индексирования и итерации будут работать со столбцами, пока режим не будет изменен снова.
Этот метод возвращает таблицу и его можно безопасно использовать в цепочке вызовов.
# File lib/csv.rb, line 638 def by_col_or_row self.class.new(@table.dup).by_col_or_row! end
Возвращает дублирующий объект таблицы в смешанном режиме. Это удобно для цепочки вызовов в одном вызове без изменения режима таблицы, но имейте в виду, что этот метод может потреблять значительный объем памяти для больших наборов данных.
Этот метод возвращает дубликат таблицы для цепочки вызовов. Однако не используйте таким образом методы, изменяющие данные (например, []=()), поскольку вы работаете с дубликатом.
# File lib/csv.rb, line 650 def by_col_or_row! @mode = :col_or_row self end
Переключает режим этой таблицы в смешанный режим. Все вызовы методов индексирования и итерации будут использовать стандартную интеллектуальную систему индексирования, пока режим не будет изменен снова. В смешанном режиме индекс считается ссылкой на строку, а все остальное считается доступом к столбцам по заголовкам.
Этот метод возвращает таблицу и его можно безопасно использовать в цепочке вызовов.
# File lib/csv.rb, line 665 def by_row self.class.new(@table.dup).by_row! end
Возвращает дублирующий объект таблицы в режиме строк. Это удобно для цепочки вызовов в одном вызове без изменения режима таблицы, но имейте в виду, что этот метод может потреблять значительный объем памяти для больших наборов данных.
Этот метод возвращает дубликат таблицы для цепочки вызовов. Однако не используйте таким образом методы, изменяющие данные (например, []=()), поскольку вы работаете с дубликатом.
# File lib/csv.rb, line 675 def by_row! @mode = :row self end
Переключает режим этой таблицы в режим строк. Все вызовы методов индексирования и итерации будут работать со строками, пока режим не будет изменен снова.
Этот метод возвращает таблицу и его можно безопасно использовать в цепочке вызовов.
# File lib/csv.rb, line 813
def delete(index_or_header)
if @mode == :row or # by index
(@mode == :col_or_row and index_or_header.is_a? Integer)
@table.delete_at(index_or_header)
else # by header
@table.map { |row| row.delete(index_or_header).last }
end
end Удаляет и возвращает указанный столбец или строку. В режиме смешанного доступа по умолчанию индексы относятся к строкам, а все остальное считается заголовком столбца. Используйте #by_col!() или #by_row!() для принудительного поиска.
# File lib/csv.rb, line 832
def delete_if(&block)
block or return enum_for(__method__) { @mode == :row or @mode == :col_or_row ? size : headers.size }
if @mode == :row or @mode == :col_or_row # by index
@table.delete_if(&block)
else # by header
deleted = []
headers.each do |header|
deleted << delete(header) if block[[header, self[header]]]
end
end
self # for chaining
end Удаляет любой столбец или строку, для которого блок возвращает true. В режиме смешанного доступа по умолчанию или режиме строк итерация представляет собой стандартный проход по строкам в порядке следования строк. В режиме столбцов итерация будет yield двухэлементные кортежи, содержащие имя столбца и массив значений для этого столбца.
Этот метод возвращает таблицу для цепочки вызовов.
Если блок не указан, возвращается Enumerator.
# File lib/csv.rb, line 858
def each(&block)
block or return enum_for(__method__) { @mode == :col ? headers.size : size }
if @mode == :col
headers.each { |header| block[[header, self[header]]] }
else
@table.each(&block)
end
self # for chaining
end В режиме смешанного доступа по умолчанию или режиме строк итерация представляет собой стандартный проход по строкам в порядке следования строк. В режиме столбцов итерация будет yield двухэлементные кортежи, содержащие имя столбца и массив значений для этого столбца.
Этот метод возвращает таблицу для цепочки вызовов.
Если блок не указан, возвращается Enumerator.
# File lib/csv.rb, line 685
def headers
if @table.empty?
Array.new
else
@table.first.headers
end
end Возвращает заголовки для первой строки этой таблицы (предполагается, что они соответствуют всем остальным строкам). Для пустых таблиц возвращается пустой массив.
# File lib/csv.rb, line 905
def inspect
"#<#{self.class} mode:#{@mode} row_count:#{to_a.size}>".encode("US-ASCII")
end Показывает режим и размер этой таблицы в строке US-ASCII.
# File lib/csv.rb, line 802
def push(*rows)
rows.each { |row| self << row }
self # for chaining
end Сокращение для добавления нескольких строк. Эквивалентно:
rows.each { |row| self << row }
Этот метод возвращает таблицу для цепочки вызовов.
# File lib/csv.rb, line 880
def to_a
array = [headers]
@table.each do |row|
array.push(row.fields) unless row.header_row?
end
return array
end Возвращает таблицу как массив массивов. Заголовки будут первой строкой, затем последуют все строки полей.
# File lib/csv.rb, line 895
def to_csv(write_headers: true, **options)
array = write_headers ? [headers.to_csv(options)] : []
@table.each do |row|
array.push(row.fields.to_csv(options)) unless row.header_row?
end
return array.join('')
end Возвращает таблицу как полную строку CSV. Заголовки будут указаны первыми, затем все строки полей.
Этот метод предполагает, что вам нужны #headers, если вы явно не передадите :write_headers => false.
# File lib/csv.rb, line 764
def values_at(*indices_or_headers)
if @mode == :row or # by indices
( @mode == :col_or_row and indices_or_headers.all? do |index|
index.is_a?(Integer) or
( index.is_a?(Range) and
index.first.is_a?(Integer) and
index.last.is_a?(Integer) )
end )
@table.values_at(*indices_or_headers)
else # by headers
@table.map { |row| row.values_at(*indices_or_headers) }
end
end По умолчанию смешанный режим интерпретирует список индексов как доступ к строкам, возвращая указанные строки. Все остальное рассматривается как доступ к столбцам. Для доступа к столбцам возвращаемое множество содержит массив для каждой строки с значениями, указанными заголовками в каждом массиве. Можно принудительно выбрать режим столбцов или строк, используя #by_col!() или #by_row!().
Смешанный доступ к столбцам и строкам невозможен.
Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.