ruby-core@ruby-lang.org archive (unofficial mirror)
 help / color / mirror / Atom feed
From: Austin Ziegler <halostatue@gmail.com>
To: Ruby developers <ruby-core@ruby-lang.org>
Subject: [ruby-core:101231] Re: [Ruby master Feature#17055] Allow suppressing uninitialized instance variable and method redefined verbose mode warnings
Date: Thu, 3 Dec 2020 17:44:38 -0500	[thread overview]
Message-ID: <CAJ4ekQvfW6A9dC0k_y73E16GRQq2GXwW3mvXJi++bSjUP0pABw@mail.gmail.com> (raw)
In-Reply-To: <redmine.journal-88891.20201202212544.1604@ruby-lang.org>


[-- Attachment #1.1: Type: text/plain, Size: 4231 bytes --]

What does this mean?

> Considering that you can alias a method to itself to avoid the warning,
and therefore do not need to remove the method first (which would cause a
race condition), I am dropping my request to add
`expected_redefined_method?(method_name)`.

I have code that I’ve written to get around some rdoc silliness that does:

  # rdoc documentation for foo.
  attr_writer :foo
  undef :foo=
  def foo=(x) #:nodoc:
    # specialized foo assignment code
  end

If I didn’t do this, RDoc documents both the attribute and the `foo=`
method (or it did the last time I checked) even though all I want
documented is the attribute for readability. How would I make it so that I
don’t need to do `undef :foo=` here, as that has been one thing that has
failed this code (_hard_) with both type analyzers for Ruby.

-a

On Wed, Dec 2, 2020 at 4:26 PM <merch-redmine@jeremyevans.net> wrote:

> Issue #17055 has been updated by jeremyevans0 (Jeremy Evans).
>
>
> During the November developer meeting, @matz seems in favor of completely
> removing the undefined instance variable warning.  I am strongly in favor
> of removing the undefined instance variable warning completely, and much
> prefer doing that instead of adding
> `expected_uninitialized_instance_variable?`.  If the undefined instance
> variable warnings are removed, there is no reason to have
> `expected_uninitialized_instance_variable?`.
>
> After discussions with @mame, the method redefinition warning is often
> helpful when writing test code using test/unit or minitest/test.
> Considering that you can alias a method to itself to avoid the warning, and
> therefore do not need to remove the method first (which would cause a race
> condition), I am dropping my request to add
> `expected_redefined_method?(method_name)`.
>
> ----------------------------------------
> Feature #17055: Allow suppressing uninitialized instance variable and
> method redefined verbose mode warnings
> https://bugs.ruby-lang.org/issues/17055#change-88891
>
> * Author: jeremyevans0 (Jeremy Evans)
> * Status: Open
> * Priority: Normal
> ----------------------------------------
> These two verbose mode warnings are both fairly common and have good
> reasons why you would not want to warn about them in specific cases.  Not
> initializing instance variables to nil can be much better for performance,
> and redefining methods without removing the method first is the only safe
> approach in multi-threaded code.
>
> There are reasons that you may want to issue verbose warnings by default
> in these cases.  For uninitialized instance variables, it helps catch
> typos. For method redefinition, it could alert you that a method already
> exists when you didn't expect it to, such as when a file is loaded multiple
> times when it should only be loaded once.
>
> I propose we keep the default behavior the same, but offer the ability to
> opt-out of these warnings by defining methods.  For uninitialized instance
> variables in verbose mode, I propose we call
> `expected_uninitialized_instance_variable?(iv)` on the object.  If this
> method doesn't exist or returns false/nil, we issue the warning.  If the
> method exists and returns true, we suppress the warning.  Similarly, for
> redefined methods, we call `expected_redefined_method?(method_name)` on the
> class or module.  If the method doesn't exist or returns false/nil, we
> issue the warning.  If the method exists and returns true, we suppress the
> warning.
>
> This approach allows high performance code (uninitialized instance
> variables) and safe code (redefining methods without removing) to work
> without verbose mode warnings.
>
> I have implemented this support in a pull request:
> https://github.com/ruby/ruby/pull/3371
>
> ---Files--------------------------------
> t.rb (5.59 KB)
>
>
> --
> https://bugs.ruby-lang.org/
>
> Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe>
> <http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>
>


-- 
Austin Ziegler • halostatue@gmail.com • austin@halostatue.ca
http://www.halostatue.ca/http://twitter.com/halostatue

[-- Attachment #1.2: Type: text/html, Size: 5534 bytes --]

[-- Attachment #2: Type: text/plain, Size: 0 bytes --]



  reply	other threads:[~2020-12-03 22:45 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-28 22:03 [ruby-core:99375] [Ruby master Feature#17055] Allow suppressing uninitialized instance variable and method redefined verbose mode warnings merch-redmine
2020-07-29  2:26 ` [ruby-core:99386] " shyouhei
2020-07-29  6:54 ` [ruby-core:99387] " kamipo
2020-07-29  9:17 ` [ruby-core:99388] " jean.boussier
2020-07-29 20:48 ` [ruby-core:99395] " eregontp
2020-07-29 20:55 ` [ruby-core:99396] " eregontp
2020-07-29 21:37 ` [ruby-core:99397] " merch-redmine
2020-07-30 18:04 ` [ruby-core:99400] " headius
2020-07-30 18:16 ` [ruby-core:99401] " headius
2020-08-01 14:36 ` [ruby-core:99439] " eregontp
2020-08-01 14:54 ` [ruby-core:99440] " eregontp
2020-08-02 15:38 ` [ruby-core:99445] " merch-redmine
2020-08-03 11:22 ` [ruby-core:99453] " eregontp
2020-08-03 16:30 ` [ruby-core:99457] " merch-redmine
2020-08-03 16:48 ` [ruby-core:99458] " tenderlove
2020-08-03 17:01 ` [ruby-core:99459] " merch-redmine
2020-08-03 18:31 ` [ruby-core:99460] " tenderlove
2020-08-04  2:59 ` [ruby-core:99472] " merch-redmine
2020-08-15 10:54 ` [ruby-core:99595] " eregontp
2020-08-15 12:23 ` [ruby-core:99596] " eregontp
2020-08-15 15:42 ` [ruby-core:99597] " merch-redmine
2020-09-01 15:56 ` [ruby-core:99819] " merch-redmine
2020-09-02 14:57 ` [ruby-core:99844] " eregontp
2020-09-02 15:35 ` [ruby-core:99845] " merch-redmine
2020-12-02 21:25 ` [ruby-core:101207] " merch-redmine
2020-12-03 22:44   ` Austin Ziegler [this message]
2020-12-03 23:04     ` [ruby-core:101233] " Jeremy Evans
2020-12-04 17:34       ` [ruby-core:101244] " Austin Ziegler
2020-12-10  4:35 ` [ruby-core:101353] " matz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.ruby-lang.org/en/community/mailing-lists/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAJ4ekQvfW6A9dC0k_y73E16GRQq2GXwW3mvXJi++bSjUP0pABw@mail.gmail.com \
    --to=ruby-core@ruby-lang.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).