GNU logs - #63410, boring messages

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Ruijie Yu <ruijie@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 May 2023 05:37:01 +0000
Resent-Message-ID: <handler.63410.B.16836970081806 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 63410 <at> debbugs.gnu.org
User-agent: mu4e 1.11.3; emacs 30.0.50
From: Ruijie Yu <ruijie@HIDDEN>
Date: Wed, 10 May 2023 13:22:34 +0800
Message-ID: <sdvwn1gagtm.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
Received-SPF: pass client-ip=152.44.41.246; envelope-from=ruijie@HIDDEN;
 helo=mail.netyu.xyz
X-Spam_score_int: -18
X-Spam_score: -1.9
X-Spam_bar: -
X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no
X-Spam_action: no action
X-Spam-Score: 0.6 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -2.4 (--)

Similar to `setopt' introduced in 29, which warns when a variable gets
assigned a value with an incorrect type, I hope `defcustom' can
(optionally) check that the standard value of a customizable variable is
correct.  This would help external as well as internal package authors
to catch errors on the types.

I don't know how to define such optionality though -- can/should it also
be a customizable variable?  Or maybe it should just be a
function/command which checks customizable variables (e.g., a single
variable; a group; all of them; etc.), and warns about all the type
mismatches along the way?

In addition, a "check all variables within this group (and
subgroups)" might be helpful as well.

At the moment, the only via workaround I know of to check existing value
type for any given variable is this:

    (setopt variable variable)

But this introduces the runtime cost of the :set function, which
sometimes do pretty expensive things like (re-) loading a package.

Another workaround I know of, of course, is to run

    M-x customize-variable

on the variable, but that is painfully slow compared to the first
workaround.

If no-one gets to it first, I may start looking into how to implement it
within a week or two.

-- 
Best,

RY

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Ruijie Yu <ruijie@HIDDEN>
Subject: bug#63410: Acknowledgement (30.0.50; [FR] Optionally allow
 defcustom to check type for standard value)
Message-ID: <handler.63410.B.16836970081806.ack <at> debbugs.gnu.org>
References: <sdvwn1gagtm.fsf@HIDDEN>
X-Gnu-PR-Message: ack 63410
X-Gnu-PR-Package: emacs
Reply-To: 63410 <at> debbugs.gnu.org
Date: Wed, 10 May 2023 05:37:01 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-gnu-emacs@HIDDEN

If you wish to submit further information on this problem, please
send it to 63410 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
63410: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D63410
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Drew Adams <drew.adams@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 May 2023 13:37:01 +0000
Resent-Message-ID: <handler.63410.B63410.168372582021293 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Ruijie Yu <ruijie@HIDDEN>, "63410 <at> debbugs.gnu.org" <63410 <at> debbugs.gnu.org>
From: Drew Adams <drew.adams@HIDDEN>
Thread-Topic: [External] : bug#63410: 30.0.50; [FR] Optionally allow defcustom
 to check type for standard value
Thread-Index: AQHZgwF/7IsqpQEHo02tbZGCWwF6ea9TgqaQ
Date: Wed, 10 May 2023 13:36:49 +0000
Message-ID: <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
References: <sdvwn1gagtm.fsf@HIDDEN>
In-Reply-To: <sdvwn1gagtm.fsf@HIDDEN>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: v7nJ+4qD0T0GbOSKCjAoWBzI1RMpsfUsLwr4up4v71/WciZnxiZ53sySBGQkvvC/+Pe8ZKcnOzwsI4cOLzOpaC3iKMoRvfh5eR9krSYbhN2Xp8SUNW6HtfjffB1ck8rmPmpA4rh5dNCtcRLZQKZ/18Yh2SfGbkrb+FioY6/7DNkavqwefBIN8j82ifnrAKTuq4I93JdQYcKOh7XwNQaDE6p/5fG2ZKBy9KvTzkYaRJWfNwVyzBLmgjRaFui42zmDLKS6TnN5/ElqRscZSq2c1lCuJurcYzaTTqJdxM12wFrRn/pPSlScDaI1YcXT4JXCbqBJmgB6UGyUYPClBRIZ+/MnWWVseEyAAKf00U83ssAr7y0aOwKB5HEEk/VBdfJvaSa54ztHMqNCeiEdBn1ZGlB7VQqnEDUN5ka8TL/ZnMLfBOOo1xii4mJSYYMGDqJZJn6pQrgfn6G44BZJ4UKODX/aXVtCN5cR7GGALb+FIiCONS3XDbSbC/5CHlnzhkDHihhTIcWP8SbKqshPUXzWUMcOXmzoNC0RzbbS+p5xgxJOb+0IR4ZI8NPVgtpunpe5E0chU1qZPvm+Z1u7adY6JUH9HxWNN5W+BRXeBls/gC9zIYYSEroswTpgWb3wujGxIBnFCb/G2Nf0ybWZkbHaP6efYf5WL5R8X8TkegSKtKxqYE2hKD09MbTQDvw+YLMcmlmx//3ggkzt2ch+Dkn6UnxE0/lxxklW49alcmXlSGUqu5Y1Lc/8AWCZCo2hlnd21FRFAYjo2700wrY33bAn9pB0M9cz7X65x+AOePlizWQjEhER15Zyu1F4vHle03YNzbwZaAXC3Z06ic8YzSK+PubgmNM4uz1+K3xR64Cc5W+WheyDCzoqIRV6Qdzegyusrgnx6WIXFv/Mm3HA5f86oXWlJCp/+fp1EWzw94P6WMnJouF+SLRE4DhhETrUegYYn5HF8rIczlysihgsD+t50YIo5cx62tjRzXfhosnCOKK7fDhp/EQMlukBFn8k2QtOuXCdmu6U8ZBNgchcLKXttToHR+qEiPWMNnrNTwpF3v6Mt4bAaodrHE4BtW1C5Tw7OPRSbQD90tu1IC+VxH/8E9lU9cnfMQXq9uCY9H0oUNnQxBSf713JuXSjrq2Eqc315CzUDU1D4QH55Sl6YvtQpDDrOjMdhb+4/zJpndCvq8FLP+cQZz3rHpI1IuV9aLy2xPDidKlsuwd+/YoBmLIplJ7GL2+F8inCzfWvYaQ7Aw/PL4XLsJiVfYVRrwTk6ZPLn2ZnBi7nxOfDeINd3Qb9FDZDuDgBciXE+sBY2+6VUY+QOX1oCYCSbLRwBEQG2ih920O0Tts6CoiU3/ZemUwLbODPv1O754MrcYW/BeS9Q/2Vg0NYY62UM0P5D0ZuA0eSfG9Llex3pgNUg4q7sqts2dR84qXOoacC7UOP3THxLkyobbkugmoco7m51XiWgUu7A9NZN8UfrgzxJb2AlWNWJZkQh7Z7FJqn+yb094A5QuRxr+/ZxUIsYXLTTm6u1+KnQO46P6/qesZFA6jrwvVdJCdkt+X+Cv0BUKtC/Sc7XNGOSY8Trg/uVxIg35wd6QBQ
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-ExternalHop-MessageData-0: SccHhEC5YSBbvSqsWWgTkM2R0tgpEDL54wu1xTWYaszhkCep3hXmSl48gg9c8MJLc2Ca502X1ZUxhANi/Cn66fyk/hSny951vG0Yl1zvdUUdotQ/gjbIlyBlmnim6lCtwJNivitTdi9uXJwTW1a5/0E59NVe+RgHJKSpbS3rQ357+u+l039/himNdztcjK1Q7vJy7DlEQkiQQluS3sfs52gN8LUjeZGHb8xAsc8/zNbMvyitViW0U9MD0b8O0kOjLZNNjsAYU+IYdwa1V+MigpsJ/esJY/qggtfi5+aPxwvaJ7V+X7QM2vuArXqFlyZKDsN9eRConEX6jAwdZpRvfLeFjlSbt3FOldSwFQoHV+VvqEFC61kHiecLq/4wk5R2IUg7/NCZpM2RgQOpE66fkV6ZL9wZRpeDhpcQA07YZi/CLOaRT70sG0sx8Ep5SeM+a271ZCrWnGm5XlezDXDaZkaZvYg2zisXij12msy7KMTHmHLmExNqIBnRnmJYSixDEgkKfTBFIaqMB1ZExcZq+8y4f6FlYZ6PSP2rJ7+7/R2tEG7WVtROfKyRkZhz7tPF/PlsOjLA6w5DcoZxOZn76ABKWRRujnf4+ORWZK+5iWhjhro3CeYk8cLXcTlA+kJ/tUkD2R/vAj3w6oZpyXN7Y6se22WWRGASIPecBc7oD73O5hOb1JitmMkA/HzGN6dzIZivrZu7wRHtgKRo8bQMm3bZCgWzt8hWt/26GWfIxrtptrNKJfes7Phzk5VVgw98XFqvDBsdZoHonrfiWyYEnnglREriJ/qUCLu6F3YSKTg=
X-OriginatorOrg: oracle.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR10MB5488.namprd10.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 05eddda1-77d5-458d-b8ab-08db515b9b88
X-MS-Exchange-CrossTenant-originalarrivaltime: 10 May 2023 13:36:49.5802 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 4e2c6054-71cb-48f1-bd6c-3a9705aca71b
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: HOHqqRsxVZgtOQeh/sjKwQZBZWaVRvXh/ws4mFoAJ0Wootvk8PlrsrjVC+xTAQyfSebQOZ7WONHBWoTmofSa0Q==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO6PR10MB5393
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22
 definitions=2023-05-10_04,2023-05-05_01,2023-02-09_01
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 mlxlogscore=916
 phishscore=0
 adultscore=0 spamscore=0 suspectscore=0 malwarescore=0 bulkscore=0
 mlxscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2304280000 definitions=main-2305100108
X-Proofpoint-GUID: Xq3XEmUwhoTvcaYZ0INFMqvusaES5Gby
X-Proofpoint-ORIG-GUID: Xq3XEmUwhoTvcaYZ0INFMqvusaES5Gby
X-Spam-Score: -0.7 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.7 (-)

> Similar to `setopt' introduced in 29, which warns when a variable gets
> assigned a value with an incorrect type, I hope `defcustom' can
> (optionally) check that the standard value of a customizable variable is
> correct.  This would help external as well as internal package authors
> to catch errors on the types.

Not sure I understand.  Doesn't it do that already,
showing "mismatch" next to the default value if it
doesn't match the type definition?

Message sent to bug-gnu-emacs@HIDDEN:

Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Ruijie Yu <ruijie@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 May 2023 14:52:02 +0000
Resent-Message-ID: <handler.63410.B63410.1683730310503 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: Drew Adams <drew.adams@HIDDEN>
Cc: "63410 <at> debbugs.gnu.org" <63410 <at> debbugs.gnu.org>
References: <sdvwn1gagtm.fsf@HIDDEN>
 <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
User-agent: mu4e 1.11.3; emacs 30.0.50
From: Ruijie Yu <ruijie@HIDDEN>
In-reply-to: <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
Date: Wed, 10 May 2023 22:51:14 +0800
Message-ID: <sdvmt2c9r4t.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Drew Adams <drew.adams@HIDDEN> writes:

>> Similar to `setopt' introduced in 29, which warns when a variable gets
>> assigned a value with an incorrect type, I hope `defcustom' can
>> (optionally) check that the standard value of a customizable variable is
>> correct.  This would help external as well as internal package authors
>> to catch errors on the types.
>
> Not sure I understand.  Doesn't it do that already,
> showing "mismatch" next to the default value if it
> doesn't match the type definition?

Yes, it does, but I think it is not "automated" enough, since you would
have to go over the variables one at a time.

My request is that Emacs should (optionally, maybe behind a defcustom,
or configure, or cli flag, etc.) warn you warn a defcustom's standard
value does not match its declared type.  Since a similar warning is
already in place for `setopt', I don't think it is farfetched to request
`defcustom' to follow suit.

Alternatively, or in addition to the above, maybe provide a
function/command that checks types for a group+subgroups, or for all
defined customizable variables.  Again, this would help package authors
to catch typing errors which would otherwise be quite difficult to
catch.

As I mentioned upthread, using `setopt' directly like the following
snippet is unnecessarily expensive: it calls the :set function of a
customizable variable, where the only thing we want is to check its
type.

```emacs-lisp
(defcustom expensive-var t
  :type 'string
  :set (lambda (n v)
         (dotimes (_ 424242) 'expensive)
         (set n v)))
(setopt expensive-var expensive-var)
;; warns the user that the type is correct, but only after spending a
;; long time in the :set function
```

-----

Let me also explain the reason behind this request.  I have encountered
this scenario multiple times, where when I `setopt' something for a
customizable variable according to its docs, I get a warning saying that
the type is incorrect.  Examples of this scenario include eshell, mu4e,
and pyim.

Seeing this type of warning would prompt me to examine the entire
package in which the warning occurs.  I would have to rgrep the entire
package, and examine the types of each defcustom one-by-one, fixing all
type errors along the way.  When I encounter difficult-to-parse types I
would do the `(setopt var var)' method to save time and brain cells.

And here comes my feature request.  We have the warning in `setopt'; we
have some visual indication in the customization view; and I want to
have one more: to know when a defcustom call defines a wrongly-typed
standard value.

-- 
Best,

RY

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Eli Zaretskii <eliz@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Wed, 10 May 2023 15:40:01 +0000
Resent-Message-ID: <handler.63410.B63410.16837331645842 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 63410
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: Ruijie Yu <ruijie@HIDDEN>
Cc: 63410 <at> debbugs.gnu.org, drew.adams@HIDDEN
Received: via spool by 63410-submit <at> debbugs.gnu.org id=B63410.16837331645842
          (code B ref 63410); Wed, 10 May 2023 15:40:01 +0000
Received: (at 63410) by debbugs.gnu.org; 10 May 2023 15:39:24 +0000
Received: from localhost ([127.0.0.1]:48718 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1pwluW-0001W9-7L
	for submit <at> debbugs.gnu.org; Wed, 10 May 2023 11:39:24 -0400
Received: from eggs.gnu.org ([209.51.188.92]:56588)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <eliz@HIDDEN>) id 1pwluT-0001Vu-7f
 for 63410 <at> debbugs.gnu.org; Wed, 10 May 2023 11:39:22 -0400
Received: from fencepost.gnu.org ([2001:470:142:3::e])
 by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@HIDDEN>)
 id 1pwluK-0001km-L5; Wed, 10 May 2023 11:39:12 -0400
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org;
 s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date:
 mime-version; bh=sSyb1D+ZC+T7U7bIEMAjrP1TpSmcdRzV5tsmnQKanyQ=; b=BnQ4KpuQmZJM
 mSmE8Vgv2yUiYbcyRsYLZe2idC0lZGyd83CLpVrp0J9wpzKSOgHp05tGsH4eZERe19MbgpK9eHASu
 Geb2ef5vpkBrYdt5HpPhyJu9naTXqOcwbiqFSxEGMiUh0y+becAy6OM59l+6Qm6HXmuRv7ExT2Gm5
 3Zb5QYD4BPzeGr0wAZPcz45sBWH45EMW0kyJWdPJ6Y4E4sJ23DKtsnyhBqlvr6dj2a6oCIufUAWTu
 YMaprzhlmzzRcy14GPxNsNHL6IHPXUZedRE4GuR/DHhSLEGK9uKI/FQHBDizhcfBu8vWDyluJrbzH
 Dlcc8eppIIZZOppNflfw4w==;
Received: from [87.69.77.57] (helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@HIDDEN>)
 id 1pwluK-00047x-55; Wed, 10 May 2023 11:39:12 -0400
Date: Wed, 10 May 2023 18:40:19 +0300
Message-Id: <83ttwk6vq4.fsf@HIDDEN>
From: Eli Zaretskii <eliz@HIDDEN>
In-Reply-To: <sdvmt2c9r4t.fsf@HIDDEN> (bug-gnu-emacs@HIDDEN)
References: <sdvwn1gagtm.fsf@HIDDEN>
 <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
 <sdvmt2c9r4t.fsf@HIDDEN>
X-Spam-Score: -2.3 (--)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

> Cc: "63410 <at> debbugs.gnu.org" <63410 <at> debbugs.gnu.org>
> Date: Wed, 10 May 2023 22:51:14 +0800
> From:  Ruijie Yu via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@HIDDEN>
> 
> My request is that Emacs should (optionally, maybe behind a defcustom,
> or configure, or cli flag, etc.) warn you warn a defcustom's standard
> value does not match its declared type.

Warn you at what time?  When defcustom is byte-compiled? when it is
evaluated at run time? when the user says "M-x set-variable"?
something else?

> Since a similar warning is already in place for `setopt', I don't
> think it is farfetched to request `defcustom' to follow suit.

setopt says it when you invoke it.  But setopt is designed to be
called as a function at run time, whereas defcustom isn't.

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Ruijie Yu <ruijie@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Thu, 11 May 2023 02:27:01 +0000
Resent-Message-ID: <handler.63410.B63410.168377196913580 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 63410
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: Eli Zaretskii <eliz@HIDDEN>
Cc: 63410 <at> debbugs.gnu.org, drew.adams@HIDDEN
Received: via spool by 63410-submit <at> debbugs.gnu.org id=B63410.168377196913580
          (code B ref 63410); Thu, 11 May 2023 02:27:01 +0000
Received: (at 63410) by debbugs.gnu.org; 11 May 2023 02:26:09 +0000
Received: from localhost ([127.0.0.1]:49357 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1pww0N-0003Wv-Ic
	for submit <at> debbugs.gnu.org; Wed, 10 May 2023 22:26:09 -0400
Received: from netyu.xyz ([152.44.41.246]:34358 helo=mail.netyu.xyz)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <ruijie@HIDDEN>) id 1pww0H-0003WX-Ve
 for 63410 <at> debbugs.gnu.org; Wed, 10 May 2023 22:26:05 -0400
Received: from fw.net.yu.netyu.xyz (<unknown> [222.248.4.98])
 by netyu.xyz (OpenSMTPD) with ESMTPSA id ffecc44c
 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); 
 Thu, 11 May 2023 02:26:00 +0000 (UTC)
References: <sdvwn1gagtm.fsf@HIDDEN>
 <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
 <sdvmt2c9r4t.fsf@HIDDEN> <83ttwk6vq4.fsf@HIDDEN>
User-agent: mu4e 1.11.3; emacs 30.0.50
From: Ruijie Yu <ruijie@HIDDEN>
In-reply-to: <83ttwk6vq4.fsf@HIDDEN>
Date: Thu, 11 May 2023 10:25:41 +0800
Message-ID: <sdv7ctfa9ju.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: 0.0 (/)


Eli Zaretskii <eliz@HIDDEN> writes:

>> Cc: "63410 <at> debbugs.gnu.org" <63410 <at> debbugs.gnu.org>
>> Date: Wed, 10 May 2023 22:51:14 +0800
>> From:  Ruijie Yu via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs@HIDDEN>
>> 
>> My request is that Emacs should (optionally, maybe behind a defcustom,
>> or configure, or cli flag, etc.) warn you warn a defcustom's standard
>> value does not match its declared type.
>
> Warn you at what time?  When defcustom is byte-compiled? when it is
> evaluated at run time? when the user says "M-x set-variable"?
> something else?

I was initially thinking of at runtime, but now that you mention it,
byte-compilation time sounds more reasonable.

So, I would say check the type unconditionally on byte-compilation time,
or when something is toggled on, check the type at runtime if a
defcustom is not compiled.

>> Since a similar warning is already in place for `setopt', I don't
>> think it is farfetched to request `defcustom' to follow suit.
>
> setopt says it when you invoke it.  But setopt is designed to be
> called as a function at run time, whereas defcustom isn't.

In that case, I had my semi-parallel second proposal: provide a command
that checks for a group of variables and see if types of all variables
within the group (or its subgroups) are correct.

-- 
Best,


RY

Message sent to bug-gnu-emacs@HIDDEN:

X-Loop: help-debbugs@HIDDEN
Subject: bug#63410: 30.0.50; [FR] Optionally allow defcustom to check type for standard value
Resent-From: Ruijie Yu <ruijie@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-gnu-emacs@HIDDEN
Resent-Date: Thu, 11 May 2023 14:09:02 +0000
Resent-Message-ID: <handler.63410.B63410.16838141247362 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
X-GNU-PR-Message: followup 63410
X-GNU-PR-Package: emacs
X-GNU-PR-Keywords: 
To: 63410 <at> debbugs.gnu.org
Cc: Eli Zaretskii <eliz@HIDDEN>, drew.adams@HIDDEN
Received: via spool by 63410-submit <at> debbugs.gnu.org id=B63410.16838141247362
          (code B ref 63410); Thu, 11 May 2023 14:09:02 +0000
Received: (at 63410) by debbugs.gnu.org; 11 May 2023 14:08:44 +0000
Received: from localhost ([127.0.0.1]:53091 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1px6yJ-0001uf-MX
	for submit <at> debbugs.gnu.org; Thu, 11 May 2023 10:08:44 -0400
Received: from netyu.xyz ([152.44.41.246]:44034 helo=mail.netyu.xyz)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <ruijie@HIDDEN>) id 1px6yE-0001uR-DA
 for 63410 <at> debbugs.gnu.org; Thu, 11 May 2023 10:08:42 -0400
Received: from fw.net.yu.netyu.xyz (<unknown> [222.248.4.98])
 by netyu.xyz (OpenSMTPD) with ESMTPSA id b44ad50d
 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); 
 Thu, 11 May 2023 14:08:36 +0000 (UTC)
References: <sdvwn1gagtm.fsf@HIDDEN>
 <SJ0PR10MB5488220DD9597357CE80230FF3779@HIDDEN>
 <sdvmt2c9r4t.fsf@HIDDEN> <83ttwk6vq4.fsf@HIDDEN>
 <sdv7ctfa9ju.fsf@HIDDEN>
User-agent: mu4e 1.11.3; emacs 30.0.50
From: Ruijie Yu <ruijie@HIDDEN>
In-reply-to: <sdv7ctfa9ju.fsf@HIDDEN>
Date: Thu, 11 May 2023 22:08:20 +0800
Message-ID: <sdvh6sj7ygb.fsf@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
X-Spam-Score: 0.0 (/)
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: 0.0 (/)

--=-=-=
Content-Type: text/plain


Ruijie Yu via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@HIDDEN> writes:

> In that case, I had my semi-parallel second proposal: provide a command
> that checks for a group of variables and see if types of all variables
> within the group (or its subgroups) are correct.

Regarding the second proposal: I have quickly hacked together a
functional example of type checking, see the attachment.  If we think
this should be integrated into Emacs, I can make some minor edits and
propose a patch.  In that case, I would probably put the functions
somewhere in cus-edit.el or custom.el.

Note that at the moment it depends on the internal function
`custom--standard-value', which is a one-line function accessing a
property of the symbol.


--=-=-=
Content-Type: text/plain
Content-Disposition: attachment; filename=cfg-check-defcustom.el

;;; cfg-check-defcustom.el --- Ensure type-strictness of defcustom

;;; Commentary:

;;; Code:
(autoload 'customize-read-group "cus-edit")
(autoload 'custom-variable-prompt "cus-edit")

(defun ccd (variable)
  "Check the standard value of VARIABLE is of the correct type."
  (interactive (custom-variable-prompt))
  (custom-load-symbol variable)
  (when-let ((type (get variable 'custom-type)))
    (let ((value (custom--standard-value variable)))
      (unless (widget-apply (widget-convert type) :match value)
        (warn "Type mismatch on `%s': value `%S'; type %s"
              variable value type)))))

(defun ccd--vars-in-group (group &optional recursive)
  "Return a list of all variable symbols contained in GROUP.
When RECURSIVE is non-nil, the list contains variables in
subgroups recursively."
  (when-let (((symbolp group))
             (gp (get group 'custom-group)))
    (let* ((filter
            (lambda (s)
              (mapcar
               #'car (seq-filter (lambda (c) (eq s (nth 1 c))) gp))))
           (child (funcall filter 'custom-variable))
           (subgroup (and recursive
                          (funcall filter 'custom-group))))
      (nconc child (mapcan #'ccd--vars-in-group-r subgroup)))))

(defun ccd--vars-in-group-r (group)
  "Shorthand for \\(cfg-check-defcustom--vars-in-group GROUP t)."
  (ccd--vars-in-group group t))

(defun ccd-group (group &optional recursive)
  "Check all variables within GROUP.
When RECURSIVE is non-nil, check the group recursively.  See also
`cfg-check-defcustom'."
  (interactive (list (customize-read-group) current-prefix-arg))
  (mapc #'ccd (ccd--vars-in-group (intern group) recursive)))

(provide 'cfg-check-defcustom)
;;; cfg-check-defcustom.el ends here.

;; Local Variables:
;; read-symbol-shorthands: (("ccd" . "cfg-check-defcustom"))
;; End:

--=-=-=
Content-Type: text/plain


Also, note that I added the symbol into the warning text because the
goal of this command is to mass-check an entire group, whereas `setopt'
did not mention the variable symbol name.  Not sure if `setopt' should
show the symbol in trouble, but I understand if we don't want to do
that.

-- 
Best,


RY

--=-=-=--

Message received at control <at> debbugs.gnu.org:

Received: (at control) by debbugs.gnu.org; 6 Sep 2023 20:28:35 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Wed Sep 06 16:28:35 2023
Received: from localhost ([127.0.0.1]:37948 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1qdz8d-0004Hx-D6
	for submit <at> debbugs.gnu.org; Wed, 06 Sep 2023 16:28:35 -0400
Received: from mail-lf1-x136.google.com ([2a00:1450:4864:20::136]:52378)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <stefankangas@HIDDEN>) id 1qdz8b-0004HZ-Pw
 for control <at> debbugs.gnu.org; Wed, 06 Sep 2023 16:28:34 -0400
Received: by mail-lf1-x136.google.com with SMTP id
 2adb3069b0e04-501cef42bc9so317772e87.0
 for <control <at> debbugs.gnu.org>; Wed, 06 Sep 2023 13:28:32 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=gmail.com; s=20221208; t=1694032107; x=1694636907; darn=debbugs.gnu.org;
 h=to:subject:message-id:date:mime-version:from:from:to:cc:subject
 :date:message-id:reply-to;
 bh=pslkt265iIJBsts3tmMvVRCUFXyxocCcFiYHX5EDIvk=;
 b=Iepim7jxYefcZIUHLe+8PPhywkEqTxwNv/1n1QkhsEFQxNt3dKgWf5TE3JTJ4IL6h1
 GtEml1EdZJuEPlVRe/C0iAPxqVWGLNpM47o2WNOHb7XIp9BIZ569PNiHM0WSbpLLmcFm
 m3+0/bmgWvROFAh5XzwPSRbYpk+wpUZew40hAoGjkFrascwgLIHYzMjVj9wRpPfpq86G
 gVc84pW+QaKq4hOJVf7cKlSxXhiR81EpGDU7NBDv+ym+XOt4z28I2OTlLcQm8LV6pipq
 sIEZ0SESY//WmIMdQyhYz24mK2xLFil81BWEEBDA1Y8wMeIsGatMKm7F+Rcv9Kj7obY6
 wsQg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20221208; t=1694032107; x=1694636907;
 h=to:subject:message-id:date:mime-version:from:x-gm-message-state
 :from:to:cc:subject:date:message-id:reply-to;
 bh=pslkt265iIJBsts3tmMvVRCUFXyxocCcFiYHX5EDIvk=;
 b=f3q5jDryiolfM2xVmllMEXpLQ/AzpJIzD5io7wjrlzTd1NK1i7sB3mGkyDqL+mzrUS
 eeihSuPpVcD4zJEkrZnP4OkxgWrGMP1PjwPBD4eCTWurrro+M3kuJloAxZ6graZ7Vl3B
 0MwS0+UVFLafmRFFkzXYjt1k0C8Wa52V5o8+QdKsR31gYYAj1t2HqvE1HQDXo6yYXHEy
 6wWp0Jtf1ZcbIRDAT6pYvVdONyKTFeHqX91mVYPQYs8rlP8GMR8czmGupwyHnC/jIK3P
 p7E9haT4yt9dz3ZCmRRvEpLT2q7lk9fngv1jFDAT6FzHBFgxrn3kPPO0xVtT73d2agso
 ekWQ==
X-Gm-Message-State: AOJu0YyWaG3vSgakLjPtIndyL8L8e0jO1Soj7jHGi5lhUVoPjzjQum7Y
 wyQ7KpDzVLlHxPEJYDeH5ICU76o1EO7VzNFCqpMjuUfUDcc=
X-Google-Smtp-Source: AGHT+IGRodykEU835Hgu6WqVXcsnkhEpEGdBX91+sd6BXN0A8wL/dMP41qoIO78PB5Prpgsg8+FSFg8AXVbvxsQNrsE=
X-Received: by 2002:a19:2d01:0:b0:500:c589:95fb with SMTP id
 k1-20020a192d01000000b00500c58995fbmr2798206lfj.55.1694032106513; Wed, 06 Sep
 2023 13:28:26 -0700 (PDT)
Received: from 753933720722 named unknown by gmailapi.google.com with
 HTTPREST; Wed, 6 Sep 2023 13:28:26 -0700
From: Stefan Kangas <stefankangas@HIDDEN>
MIME-Version: 1.0
Date: Wed, 6 Sep 2023 13:28:26 -0700
Message-ID: <CADwFkmmVZJKL066L8YPzBZx_7sbkO7TCayH9h1LbD30zdjwxbA@HIDDEN>
Subject: control message for bug #63410
To: control <at> debbugs.gnu.org
Content-Type: text/plain; charset="UTF-8"
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: control
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -1.0 (-)

severity 63410 wishlist
quit

Last modified: Wed, 6 Sep 2023 20:30:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.