Make setters private (rework of #69) by glennmatthews · Pull Request #107 · PyCQA/pydocstyle

glennmatthews · 2015-02-18T15:25:55Z

Rework #69 to patch cleanly with latest master code.

Example code:

class COTInfo(COTGenericSubmodule):

    """Display VM information string."""

    def __init__(self, UI):
        """Instantiate this submodule with the given UI."""
        super(COTInfo, self).__init__(UI)
        self._package_list = None
        self._verbosity = None

    @property
    def package_list(self):
        """List of VM definitions to get information for."""
        return self._package_list

    @package_list.setter
    def package_list(self, value):
        for package in value:
            if not os.path.exists(package):
                raise InvalidInputError("Specified package {0} does not exist!"
                                        .format(package))
        self._package_list = value

    @property
    def verbosity(self):
        """Verbosity of information displayed."""
        return self._verbosity

    @verbosity.setter
    def verbosity(self, value):
        if value not in ['brief', 'verbose', None]:
            raise InvalidInputError(
                "Verbosity must be 'brief', 'verbose', or None")
        self._verbosity = value

Before - pep257 wants docstrings on setter methods:

> pep257 COT/info.py
COT/info.py:45 in public method `package_list`:
        D102: Docstring missing
COT/info.py:58 in public method `verbosity`:
        D102: Docstring missing
>

After - setters are ignored:

> /pep257 ../cot/COT/info.py
>

glennmatthews · 2015-03-03T02:06:14Z

This is technically an incomplete fix, as the same issue can exist with functions decorated as @foo.deleter - I'll look into that when I get a chance but in my experience setters are more common so this is valuable even in its current form.

glennmatthews · 2015-03-03T02:20:59Z

Looks like the original implementation covered deleters as well. I've just added a unit test to confirm this.

glennmatthews · 2015-03-17T20:59:43Z

Anything I can do to move this along? I can't adopt pep257 for my project without this fix:

$ pep257 COT
COT/add_disk.py:80 in public method `disk_image`:
        D102: Missing docstring in public method
COT/add_disk.py:96 in public method `address`:
        D102: Missing docstring in public method
COT/add_disk.py:111 in public method `controller`:
        D102: Missing docstring in public method
COT/add_file.py:62 in public method `file`:
        D102: Missing docstring in public method
COT/deploy.py:106 in public method `hypervisor`:
        D102: Missing docstring in public method
COT/deploy.py:121 in public method `configuration`:
        D102: Missing docstring in public method
COT/deploy.py:137 in public method `power_on`:
        D102: Missing docstring in public method
COT/deploy.py:260 in public method `ovftool_args`:
        D102: Missing docstring in public method
COT/edit_hardware.py:94 in public method `cpus`:
        D102: Missing docstring in public method
COT/edit_hardware.py:110 in public method `memory`:
        D102: Missing docstring in public method
COT/edit_hardware.py:150 in public method `nics`:
        D102: Missing docstring in public method
COT/edit_hardware.py:164 in public method `nic_type`:
        D102: Missing docstring in public method
COT/edit_hardware.py:174 in public method `serial_ports`:
        D102: Missing docstring in public method
COT/edit_properties.py:66 in public method `config_file`:
        D102: Missing docstring in public method
COT/edit_properties.py:78 in public method `properties`:
        D102: Missing docstring in public method
COT/help.py:52 in public method `subcommand`:
        D102: Missing docstring in public method
COT/info.py:53 in public method `package_list`:
        D102: Missing docstring in public method
COT/info.py:66 in public method `verbosity`:
        D102: Missing docstring in public method
COT/inject_config.py:62 in public method `config_file`:
        D102: Missing docstring in public method
COT/inject_config.py:84 in public method `secondary_config_file`:
        D102: Missing docstring in public method
COT/ovf.py:371 in public method `output_file`:
        D102: Missing docstring in public method
COT/ovf.py:491 in public method `system_types`:
        D102: Missing docstring in public method
COT/ovf.py:514 in public method `version_short`:
        D102: Missing docstring in public method
COT/submodule.py:131 in public method `package`:
        D102: Missing docstring in public method
COT/submodule.py:184 in public method `package`:
        D102: Missing docstring in public method
COT/submodule.py:206 in public method `output`:
        D102: Missing docstring in public method
COT/vm_description.py:121 in public method `output_file`:
        D102: Missing docstring in public method
COT/vm_description.py:180 in public method `system_types`:
        D102: Missing docstring in public method
COT/vm_description.py:189 in public method `version_short`:
        D102: Missing docstring in public method
COT/vm_description.py:198 in public method `version_long`:
        D102: Missing docstring in public method
COT/helpers/helper.py:220 in public method `name`:
        D102: Missing docstring in public method

Nurdok · 2015-03-18T09:47:39Z

I will take a look at it over the weekend. Sorry for the delay.
On Mar 17, 2015 11:00 PM, "Glenn Matthews" notifications@github.com wrote:

Anything I can do to move this along? I can't adopt pep257 for my project
without this fix:

$ pep257 COT
COT/add_disk.py:80 in public method disk_image:
D102: Missing docstring in public method
COT/add_disk.py:96 in public method address:
D102: Missing docstring in public method
COT/add_disk.py:111 in public method controller:
D102: Missing docstring in public method
COT/add_file.py:62 in public method file:
D102: Missing docstring in public method
COT/deploy.py:106 in public method hypervisor:
D102: Missing docstring in public method
COT/deploy.py:121 in public method configuration:
D102: Missing docstring in public method
COT/deploy.py:137 in public method power_on:
D102: Missing docstring in public method
COT/deploy.py:260 in public method ovftool_args:
D102: Missing docstring in public method
COT/edit_hardware.py:94 in public method cpus:
D102: Missing docstring in public method
COT/edit_hardware.py:110 in public method memory:
D102: Missing docstring in public method
COT/edit_hardware.py:150 in public method nics:
D102: Missing docstring in public method
COT/edit_hardware.py:164 in public method nic_type:
D102: Missing docstring in public method
COT/edit_hardware.py:174 in public method serial_ports:
D102: Missing docstring in public method
COT/edit_properties.py:66 in public method config_file:
D102: Missing docstring in public method
COT/edit_properties.py:78 in public method properties:
D102: Missing docstring in public method
COT/help.py:52 in public method subcommand:
D102: Missing docstring in public method
COT/info.py:53 in public method package_list:
D102: Missing docstring in public method
COT/info.py:66 in public method verbosity:
D102: Missing docstring in public method
COT/inject_config.py:62 in public method config_file:
D102: Missing docstring in public method
COT/inject_config.py:84 in public method secondary_config_file:
D102: Missing docstring in public method
COT/ovf.py:371 in public method output_file:
D102: Missing docstring in public method
COT/ovf.py:491 in public method system_types:
D102: Missing docstring in public method
COT/ovf.py:514 in public method version_short:
D102: Missing docstring in public method
COT/submodule.py:131 in public method package:
D102: Missing docstring in public method
COT/submodule.py:184 in public method package:
D102: Missing docstring in public method
COT/submodule.py:206 in public method output:
D102: Missing docstring in public method
COT/vm_description.py:121 in public method output_file:
D102: Missing docstring in public method
COT/vm_description.py:180 in public method system_types:
D102: Missing docstring in public method
COT/vm_description.py:189 in public method version_short:
D102: Missing docstring in public method
COT/vm_description.py:198 in public method version_long:
D102: Missing docstring in public method
COT/helpers/helper.py:220 in public method name:
D102: Missing docstring in public method

—
Reply to this email directly or view it on GitHub
#107 (comment).

Nurdok · 2015-03-22T17:51:34Z

Make this a tuple instead (it shouldn't be mutable).

Nurdok · 2015-03-22T18:04:57Z

I added my code review as comments.
Other than that, please also add your change to the release notes in the docs, under the development version.

Thanks!

glennmatthews · 2015-03-22T19:32:03Z

Thanks for the thorough review! I'll address the comments and provide an updated changeset.

Bump version to 0.5.0

Nurdok · 2015-03-24T18:45:37Z

This should be a tuple too.

Nurdok · 2015-03-24T18:46:57Z

@glennmatthews just one more tiny fix and I'll merge this :)

glennmatthews · 2015-03-25T14:20:57Z

Done. Thanks again! (And thanks to @adiroiban for the initial version of this enhancement)

Make setters private (rework of #69)

glennmatthews · 2015-06-30T14:35:32Z

@Nurdok Can I expect a new release any time soon? I would like to enable pep257 on my project. 😄

Nurdok · 2015-06-30T15:22:30Z

@glennmatthews I'm currently working on a #96 and a version will be released once I'm done. It might take 2-3 weeks, though.

glennmatthews · 2015-06-30T15:33:55Z

Good enough for me. :-) Thanks for the reply!

Glenn

Update PyCQA#69 to latest code

bbe1c9a

glennmatthews added 2 commits March 2, 2015 21:15

Merge remote-tracking branch 'upstream/master'

d797f3d

Update to latest, add test for property deleter method.

87f5007

Nurdok reviewed Mar 22, 2015
View reviewed changes

Comment thread pep257.py Outdated

Nurdok Mar 22, 2015

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make this a tuple instead (it shouldn't be mutable).

glennmatthews added 3 commits March 23, 2015 11:06

Address code review comments from @Nurdok.

83a6327

Merge pull request #1 from GreenSteam/master

b4a6fdf

Bump version to 0.5.0

Updated release note as requested.

25d11b6

Nurdok reviewed Mar 24, 2015
View reviewed changes

Comment thread pep257.py Outdated

Nurdok Mar 24, 2015

Copy link
Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a tuple too.

One more code review fix

84ab3f2

Nurdok added a commit that referenced this pull request Mar 25, 2015

Merge pull request #107 from glennmatthews/master

2b02b18

Make setters private (rework of #69)

Nurdok merged commit 2b02b18 into PyCQA:master Mar 25, 2015

glennmatthews mentioned this pull request Jul 9, 2015

Make setters private #69

Closed

Conversation

glennmatthews commented Feb 18, 2015

Uh oh!

glennmatthews commented Mar 3, 2015

Uh oh!

glennmatthews commented Mar 3, 2015

Uh oh!

glennmatthews commented Mar 17, 2015

Uh oh!

Nurdok commented Mar 18, 2015

Uh oh!

Nurdok Mar 22, 2015

Choose a reason for hiding this comment

Uh oh!

Nurdok commented Mar 22, 2015

Uh oh!

glennmatthews commented Mar 22, 2015

Uh oh!

Nurdok Mar 24, 2015

Choose a reason for hiding this comment

Uh oh!

Nurdok commented Mar 24, 2015

Uh oh!

glennmatthews commented Mar 25, 2015

Uh oh!

glennmatthews commented Jun 30, 2015

Uh oh!

Nurdok commented Jun 30, 2015

Uh oh!

glennmatthews commented Jun 30, 2015

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants