Deprecate DataSet.vectors

[MatthewFlamm]

Overview

As discussed in #1430, this PR deprecates the usage of DataSet.vectors to set and retrieve vector data. Today, pyvista does not explicitly distinguish between vector and scalar data other than DataSet.active_vectors and related methods.

The DataSet.vectors usage is a simple shorthand for

DataSet['_vectors'] = data
DataSet.active_vectors_name = "_vectors"

This however leads to confusion as there is no special method for setting/retrieving scalars, tensors, etc.... (see pyvista/pyvista-support#448). It is also unintuitive to have a key with a leading underscore, which suggest that this shouldn't be used by users.

Details

Related to #1431, but not directly.

Closes #1430.

The warning message looks like:

pyvista/pyvista/core/dataset.py:256: PyvistaDeprecationWarning: Use of `DataSet.vectors` to add vector data is deprecated. Use `DataSet['vector_name'] = data` or `DataSet.point_arrays['vector_name'] = data` or `DataSet.cell_arrays['vector_name'] = data`. Use `DataSet.set_active_vectors('vector_name')` or `DataSet.active_vectors_name = 'vector_name' to make active.

I'm not sure why there is a hanging warnings.warn( at the end. I think I followed the same logic as the other deprecations in the codebase.

[codecov]

Codecov Report

Merging #1461 (eb7216e) into main (8d0fe22) will decrease coverage by 0.06%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##             main    #1461      +/-   ##
==========================================
- Coverage   90.05%   89.98%   -0.07%     
==========================================
  Files          65       65              
  Lines       12437    12460      +23     
==========================================
+ Hits        11200    11212      +12     
- Misses       1237     1248      +11     

[tkoyama010]

@MatthewFlamm Thanks for PR. Awesome job! I have 1 comment.

[adeak]

I'm not sure why there is a hanging warnings.warn( at the end. I think I followed the same logic as the other deprecations in the codebase.

When you raise a warning or an error the exact line that emits the warning or error is also shown. This is normal. But when there are linebreaks in the line that emits the warning or error, only the first line is printed:

$ cat tmp.py
raise ValueError('potato '
       'potahtoe')

$ python tmp.py 
Traceback (most recent call last):
  File "/home/adeak/tmp.py", line 1, in <module>
    raise ValueError('potato '
ValueError: potato potahtoe

[MatthewFlamm]

When you raise a warning or an error the exact line that emits the warning or error is also shown. This is normal. But when there are linebreaks in the line that emits the warning or error, only the first line is printed:

This I learned today. This makes it important to include something on that first line.

[adeak]

I wouldn't worry about it too much. At worst one could define the long message in a separate variable and then have the warning on a single line.