From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.1 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DD7FFC433DB for ; Wed, 17 Feb 2021 16:09:12 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 4820064E2F for ; Wed, 17 Feb 2021 16:09:12 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 4820064E2F Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=redhat.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:57550 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lCPO3-0003jN-CC for qemu-devel@archiver.kernel.org; Wed, 17 Feb 2021 11:09:11 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:53530) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lCPMQ-0002kg-C0 for qemu-devel@nongnu.org; Wed, 17 Feb 2021 11:07:30 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:25440) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1lCPMN-0008Oi-Cf for qemu-devel@nongnu.org; Wed, 17 Feb 2021 11:07:29 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1613578045; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=nnvbOEgKpV0k7TMTnKJo8eVRFP3QkXXnXYdrnNeKUGY=; b=CQGxB2kU3E4CbkpDKLLbbHkzV9u6gZ5AXnRYsG5TNIkczLjydgZum3nlir62R8yB0Abquf D7qGgB/7tq/BckucN7rmXXLVOTKS4sLhyU7sXrN3pRKAtpaqpgn69fqrk25WlN8/LtmG1/ aEGLl3xb4B9BdfT29StIoH3AUZ8SQA0= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-334-VGpyHkHXMY66o2-Uhf18hQ-1; Wed, 17 Feb 2021 11:07:21 -0500 X-MC-Unique: VGpyHkHXMY66o2-Uhf18hQ-1 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id E2FCD107ACE4; Wed, 17 Feb 2021 16:07:20 +0000 (UTC) Received: from [10.10.112.247] (ovpn-112-247.rdu2.redhat.com [10.10.112.247]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1FAC45D748; Wed, 17 Feb 2021 16:07:19 +0000 (UTC) Subject: Re: [PATCH v6 15/19] qapi/introspect.py: Add docstrings to _gen_tree and _tree_to_qlit To: Markus Armbruster References: <20210216021809.134886-1-jsnow@redhat.com> <20210216021809.134886-16-jsnow@redhat.com> <875z2r6njn.fsf@dusky.pond.sub.org> From: John Snow Message-ID: <377a32a9-2ace-dac2-dfd6-3db8d581f72c@redhat.com> Date: Wed, 17 Feb 2021 11:07:18 -0500 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.0 MIME-Version: 1.0 In-Reply-To: <875z2r6njn.fsf@dusky.pond.sub.org> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=jsnow@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Received-SPF: pass client-ip=63.128.21.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, NICE_REPLY_A=-0.001, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Michael Roth , Cleber Rosa , qemu-devel@nongnu.org, Eduardo Habkost Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" On 2/17/21 4:39 AM, Markus Armbruster wrote: > John Snow writes: > >> Signed-off-by: John Snow >> --- >> scripts/qapi/introspect.py | 18 ++++++++++++++++++ >> 1 file changed, 18 insertions(+) >> >> diff --git a/scripts/qapi/introspect.py b/scripts/qapi/introspect.py >> index 45284af1330..5d4f5e23f7e 100644 >> --- a/scripts/qapi/introspect.py >> +++ b/scripts/qapi/introspect.py >> @@ -99,6 +99,15 @@ def __init__(self, value: _ValueT, ifcond: Iterable[str], >> def _tree_to_qlit(obj: JSONValue, >> level: int = 0, >> dict_value: bool = False) -> str: >> + """ >> + Convert the type tree into a QLIT C string, recursively. >> + >> + :param obj: The value to convert. >> + This value may not be Annotated when dict_value is True. >> + :param level: The indentation level for this particular value. >> + :param dict_value: True when the value being processed belongs to a >> + dict key; which suppresses the output indent. >> + """ >> >> def indent(level: int) -> str: >> return level * 4 * ' ' >> @@ -244,6 +253,15 @@ def _gen_features(features: List[QAPISchemaFeature] >> def _gen_tree(self, name: str, mtype: str, obj: Dict[str, object], >> ifcond: Sequence[str], >> features: Optional[List[QAPISchemaFeature]]) -> None: >> + """ >> + Build and append a SchemaInfo object to self._trees. >> + >> + :param name: The entity's name. >> + :param mtype: The entity's meta-type. >> + :param obj: Additional entity fields, as appropriate for the meta-type. > > "Additional members", since we're talking about a JSON object. > I thought "field" was also appropriate for JSON, but I suppose the spec doesn't use that word. Over time, "field", "member" and "property" have become just meaningless word-slurry to me. OK. "Additional members as appropriate for the meta-type." >> + :param ifcond: Sequence of conditionals that apply to this entity. >> + :param features: Optional features field for SchemaInfo. > > Likewise. > "Optional features member for SchemaInfo" ? Sure. > Sure we want to restate parts of the type ("Sequence of", "Optional") in > the doc string? > I usually avoid it, but sometimes for non-scalars I found that it read better to give a nod to the plural, as in: [ifcond is a] sequence of conditionals ... but, yes, I haven't been consistent about it. right below for @obj I omit the type of the container. "Conditionals that apply to this entity" feels almost too terse in isolation. I don't feel like it's a requisite to state the type, but in some cases I unconsciously chose to mention the structure. With regards to "Optional", I use this word specifically to indicate parameters that have default values -- distinct from a type that's Optional[], which is really actually like Nullable[T] ... If it makes you feel better, Guido says he regrets that naming decision. Oops! I'm probably not consistent about when I decided to write it, though. Ehm. If it's not harmful to leave it as-is, I think it'd be okay to do so. If you prefer a consistency all one way or all the other, I'd have to run the vacuum back over the series to check for it. >> + """ >> comment: Optional[str] = None >> if mtype not in ('command', 'event', 'builtin', 'array'): >> if not self._unmask: > > Also: more line-wrapping for PEP 8. > I thought the 72 column limit was for things like comments and docstrings.