Delete or warn deprecated (rev.3) #3424

shyouhei · 2020-08-17T01:29:22Z

Revised #3412

Feature	Warned (without `-w`) since	This pull request
`Hash#index`	1.9.0	Deletes it
`IO#bytes`	2.0.0	Deletes it
`Enumerator.new` without a block	2.0.0	Deletes it
`Thread.exclusive`	2.3.0	Deletes it
`Data`	2.5.0	Deletes it
`Struct::Tms`	2.6.0	Deletes it
`Object#=~`	2.7.0	Deletes it
`Dir.exists?`	2.8.0	Knells for 3.2
`FileTest.exists?`	2.8.0	Knells for 3.1
`$,`,`$/`,`$\`,`$;`	2.8.0	Knells for 3.1
`lambda(&variable)`	2.8.0	Knells for 3.1

Suggest and removal can both be useful at the same time.

Has been deprecated since 22a9613.

Has been deprecated since 058d55a.

Has been deprecated since 0c97c8e.

Has been deprecated since 373282f.

This commit deletes {IO,ARGF,StringIO,Zib::GZipReader}#{bytes,chars,lines,codepoints}, which have been deprecated since c47c095. Note that String also has those methods. They are neither depreacted nor deleted because they are not aliases of counterpart each_something.

Has been deprecated since ebff9dc.

Has been deprecated since 684bdf6. Matz says in [ruby-core:83954] that Data should be an alias of Object. Because rb_cData has not been deprecated, let us deprecate the constant to make it a C-level synonym of rb_cObject.

Has been deprecated since 2069c9e.

Has been deprecated since 44c53ee.

Has been deprecated since c73b6bd. [Feature #17116] [ruby-dev:50945]

Has been deprecated since 3ee0648.

Has been deprecated since 2188d6d.

Has been deprecated since 4d1f86a.

Proper annotation of when to remove a feature helps us a lot ("don't delete it now" sign), but can rarely be useful to end users. Let's just use the info internally.

jeremyevans · 2020-08-17T03:52:00Z

io.c

@@ -7641,7 +7587,7 @@ deprecated_str_setter(VALUE val, ID id, VALUE *var)
 {
    rb_str_setter(val, id, &val);
    if (!NIL_P(val)) {
-        rb_warn_deprecated("`%s'", NULL, rb_id2name(id));
+        rb_warn_deprecated_to_remove("`%s'", "3.1", rb_id2name(id));


Should this be rb_warn_deprecated_to_remove_use_this_one_instead

jeremyevans

Looks like the bundled gems tests error because power_assert uses pry and pry relies on Object#=~, so that will have to be fixed before this can be merged.

The changes look fine to me. rb_warn_deprecated_to_remove_use_this_one_instead is quite long, and I'm not sure in which case it should be used instead of rb_warn_deprecated_to_remove.

shyouhei · 2020-08-17T04:12:48Z

@jeremyevans Yes, the test-bundled-gems issue is pry/pry#2149 (merged). Am waiting for their release.

sandstrom · 2020-09-10T20:59:41Z

Awesome to see cleanups and deprecations for Ruby 3.0! 🎉

marcandre · 2020-12-01T19:02:09Z

Aren't many of these methods still not warning (without -w)?

$ ruby -e 'puts({ok: 1}.index(1))'
ok
$ ruby -e 'Enumerator.new(42); p :ok'
:ok
$ ruby -e 'Object.new =~ 42; p :ok'
:ok

(with 2.7.2p137 or ruby-head)

jeremyevans · 2020-12-01T19:16:10Z

Aren't many of these methods still not warning (without -w)?
$ ruby -e 'puts({ok: 1}.index(1))'
ok
$ ruby -e 'Enumerator.new(42); p :ok'
:ok
$ ruby -e 'Object.new =~ 42; p :ok'
:ok
(with 2.7.2p137 or ruby-head)

That's due to a different change in Ruby 2.7.2 to not display any deprecation warnings by default. The warnings show up with -W:deprecated:

$ ruby -W:deprecated -e 'puts({ok: 1}.index(1))'
-e:1: warning: Hash#index is deprecated; use Hash#key instead
ok
$ ruby -W:deprecated -e 'Enumerator.new(42); p :ok'
-e:1: warning: Enumerator.new without a block is deprecated; use Object#to_enum instead
:ok
$ ruby -W:deprecated -e 'Object.new =~ 42; p :ok'
-e:1: warning: deprecated Object#=~ is called on Object; it always returns nil
:ok

marcandre · 2020-12-01T20:28:33Z

That's due to a different change in Ruby 2.7.2 to not display any deprecation warnings by default.

Ah, right, I forgot about this, thanks 🤦‍♂️

nobu · 2020-12-02T12:15:10Z

As now we suppress deprecation warnings by default, does non-verbose warning period really makes sense?

nobu · 2020-12-26T01:08:45Z

dir.c

@@ -3345,7 +3345,7 @@ rb_file_directory_p(void)
 static VALUE
 rb_dir_exists_p(VALUE obj, VALUE fname)
 {
-    rb_warn_deprecated("Dir.exists?", "Dir.exist?");
+    rb_warn_deprecated_to_remove_use_this_one_instead("Dir.exists?", "3.2", "Dir.exist?");


Why is only this 3.2?

@nobu Read #3412 discussion.

I should have asked about FileTest.exists? in the table at this page.
As that method is to be removed at 3.2 in the code, just the table is outdated a little?

I missed that the table updated in rev. 2...

shyouhei added 15 commits August 17, 2020 09:28

rb_warn_deprecated_to_remove_use_this_one_instead: add

4c810b0

Suggest and removal can both be useful at the same time.

Dir.exists?: to remove in 3.2.

8aaf679

Has been deprecated since 22a9613.

FileTest.exists?: to remove in 3.2.

c66fe94

Has been deprecated since 058d55a.

Hash#index: delete

1b5f5a1

Has been deprecated since 0c97c8e.

ENV.index: delete

ef0b8d5

Has been deprecated since 373282f.

Kernel#=~: delete

de87851

Has been deprecated since ebff9dc.

Data: delete

edcfb43

Has been deprecated since 684bdf6. Matz says in [ruby-core:83954] that Data should be an alias of Object. Because rb_cData has not been deprecated, let us deprecate the constant to make it a C-level synonym of rb_cObject.

Thread.exclusive: delete

f762b29

Has been deprecated since 2069c9e.

Struct::Tms: delete

06c3c1b

Has been deprecated since 44c53ee.

Enumerator.new: raise unless block given

7fd2979

Has been deprecated since c73b6bd. [Feature #17116] [ruby-dev:50945]

deprecated_str_setter: to remove in 3.1

bcf8f12

Has been deprecated since 3ee0648.

non-literal lambda: to remove in 3.1

bda22ea

Has been deprecated since 2188d6d.

rb_fs_setter: to remove in 3.1

e124f6b

Has been deprecated since 4d1f86a.

warn_deprecated_i: do not print future version

2f730d8

Proper annotation of when to remove a feature helps us a lot ("don't delete it now" sign), but can rarely be useful to end users. Let's just use the info internally.

shyouhei requested review from jeremyevans, nobu and marcandre August 17, 2020 01:29

shyouhei mentioned this pull request Aug 17, 2020

Delete or warn deprecated features (rev. 2) #3412

Closed

jeremyevans reviewed Aug 17, 2020

View changes

jeremyevans approved these changes Aug 17, 2020

View changes

Merge branch 'master' into delete-or-warn-deprecated2

a996ebb

marcandre mentioned this pull request Dec 1, 2020

Remove deprecated methods #3835

Closed

nobu reviewed Dec 26, 2020

View changes

nobu approved these changes Dec 26, 2020

View changes

Delete or warn deprecated (rev.3) #3424

Delete or warn deprecated (rev.3) #3424

shyouhei commented Aug 17, 2020 •

edited

jeremyevans Aug 17, 2020

jeremyevans left a comment

shyouhei commented Aug 17, 2020

sandstrom commented Sep 10, 2020

marcandre commented Dec 1, 2020 •

edited

jeremyevans commented Dec 1, 2020

marcandre commented Dec 1, 2020

nobu commented Dec 2, 2020

nobu Dec 26, 2020

shyouhei Dec 27, 2020

nobu Dec 27, 2020

nobu Dec 27, 2020

Delete or warn deprecated (rev.3) #3424

Are you sure you want to change the base?

Delete or warn deprecated (rev.3) #3424

Conversation

shyouhei commented Aug 17, 2020 • edited

jeremyevans Aug 17, 2020

Choose a reason for hiding this comment

jeremyevans left a comment

Choose a reason for hiding this comment

shyouhei commented Aug 17, 2020

sandstrom commented Sep 10, 2020

marcandre commented Dec 1, 2020 • edited

jeremyevans commented Dec 1, 2020

marcandre commented Dec 1, 2020

nobu commented Dec 2, 2020

nobu Dec 26, 2020

Choose a reason for hiding this comment

shyouhei Dec 27, 2020

Choose a reason for hiding this comment

nobu Dec 27, 2020

Choose a reason for hiding this comment

nobu Dec 27, 2020

Choose a reason for hiding this comment

shyouhei commented Aug 17, 2020 •

edited

marcandre commented Dec 1, 2020 •

edited