Make Proutes AMAZING: Fix checks for @wsgiapp2, MultiView, and add request method #1488

sontek · 2014-12-15T04:17:30Z

Pyramid 1.5.2:

Name            Pattern                        View                     
----            -------                        ----                     
debugtoolbar    /_debug_toolbar/*subpath       <function decorator at 0x22656e0>
__static/       /static/*subpath               <function <pyramid.static.static_view object at 0x2257750> at 0x2265aa0>
__static2/      /static2/*subpath              <function <pyramid.static.static_view object at 0x2257810> at 0x2265cf8>
__pdt_images/   /pdt_images/*subpath           <function <pyramid.static.static_view object at 0x2257910> at 0x2265ed8>
a               /                              None                     
no_view_attached /                              None                     
route_and_view_attached /                              <function route_and_view_attached at 0x2271398>
only_post_on_route /route                         <function route_and_view_attached at 0x22715f0>
only_post_on_view /view                          <function route_and_view_attached at 0x22719b0>
method_intersection /intersection                  <function route_and_view_attached at 0x2271d70>
method_conflicts /conflicts                     <function route_and_view_attached at 0x22741b8>
multiview       /multiview                     <pyramid.config.views.MultiView object at 0x2275450>
class_based_view /classes                       <function ClassBasedView at 0x2274f50>
factory         /factory                       <unknown>                
not_post        /not_post                      <function route_and_view_attached at 0x22775f0>
not_post_only_get /not_post_only_get             <function route_and_view_attached at 0x22779b0>

Before this PR (i.e in master but not released):

Name                       Pattern                     View                                                              
----                       -------                     ----                                                              
debugtoolbar               /_debug_toolbar/*subpath    pyramid.router.decorator                                          
__static/                  /static/*subpath            pyramid.static.<pyramid.static.static_view object at 0x2f984d0>   
__static2/                 /static2/*subpath           pyramid.static.<pyramid.static.static_view object at 0x2f98590>   
__pdt_images/              /pdt_images/*subpath        pyramid.static.<pyramid.static.static_view object at 0x2f98690>   
a                          /                           None                                                              
no_view_attached           /                           None                                                              
route_and_view_attached    /                           dummy_starter.standard_views.route_and_view_attached              
only_post_on_route         /route                      dummy_starter.standard_views.route_and_view_attached              
only_post_on_view          /view                       dummy_starter.standard_views.route_and_view_attached              
method_intersection        /intersection               dummy_starter.standard_views.route_and_view_attached              
method_conflicts           /conflicts                  dummy_starter.standard_views.route_and_view_attached              
multiview                  /multiview                  dummy_starter.standard_views.hello_world                          
class_based_view           /classes                    dummy_starter.standard_views.ClassBasedView                       
factory                    /factory                    dummy_starter.standard_views.route_and_view_attached              
not_post                   /not_post                   dummy_starter.standard_views.route_and_view_attached              
not_post_only_get          /not_post_only_get          dummy_starter.standard_views.route_and_view_attached

After:

Name                       Pattern                     View                                                    Method             
----                       -------                     ----                                                    ------             
debugtoolbar               /_debug_toolbar/*subpath    <wsgiapp>                                               *                  
__static/                  /static/*subpath            dummy_starter:static/                                   *                  
__static2/                 /static2/*subpath           /var/www/static/                                        *                  
__pdt_images/              /pdt_images/*subpath        pyramid_debugtoolbar:static/img/                        *                  
a                          /                           <unknown>                                               *                  
no_view_attached           /                           <unknown>                                               *                  
route_and_view_attached    /                           dummy_starter.standard_views.route_and_view_attached    *                  
only_post_on_route         /route                      dummy_starter.standard_views.route_and_view_attached    POST               
only_post_on_view          /view                       dummy_starter.standard_views.route_and_view_attached    POST               
method_intersection        /intersection               dummy_starter.standard_views.route_and_view_attached    POST               
method_conflicts           /conflicts                  dummy_starter.standard_views.route_and_view_attached    <route mismatch>   
multiview                  /multiview                  dummy_starter.standard_views.route_and_view_attached    GET,PATCH          
multiview                  /multiview                  dummy_starter.standard_views.hello_world                POST               
class_based_view           /classes                    dummy_starter.standard_views.ClassBasedView             POST               
factory                    /factory                    dummy_starter.standard_views.route_and_view_attached    *                  
not_post                   /not_post                   dummy_starter.standard_views.route_and_view_attached    !POST,*            
not_post_only_get          /not_post_only_get          dummy_starter.standard_views.route_and_view_attached    GET

Outside of the more readable format there is now 2 command line arguments --glob and --format:

Glob lets you filter your routes:

$ proutes development.ini --glob='get_user*'
Name                      Pattern                                  View                                                 Method
----                      -------                                  ----                                                 ------
get_user_info             /profilesvc/v1/get_user_info             profilesvc.views.user_info.get_user_info             *
get_user_questions        /profilesvc/v1/get_user_questions        profilesvc.views.user_info.get_user_questions        *
get_user_qb_categories    /profilesvc/v1/get_user_qb_categories    profilesvc.views.user_info.get_user_qb_categories    *

Format allows you to choose which columns are visible:

$ proutes development.ini -f name,view,method --glob home
Name    View            Method              
----    ----            ------              
home    testapp.home    <route mismatch>

The format flag can also be placed in the ini with the [proutes] section:

[proutes]
format = name
         view
         method

This also fixes #1180

sontek · 2014-12-15T04:19:28Z

@mmerickel @mcdonc Please review. Just realized I probably broke py26 support but I'll fix that :)

msabramo · 2014-12-15T07:49:03Z

I'm on my phone so didn't review thoroughly but maybe you want to mention in the PR title or description that this is for proutes?

msabramo · 2014-12-15T12:37:14Z

Now we're talking :)

sontek · 2014-12-23T17:39:43Z

@mmerickel Don't forget to review this amazing PR

msabramo · 2014-12-23T22:41:14Z

This is cool; maybe my route and view names are too long, because one negative is that I had to shrink my font size way down in order to fit into the width of my laptop screen.

On the plus side, I might be able to get IT to get me a bigger monitor to run proutes.

msabramo · 2014-12-23T22:43:33Z

If proutes allowed me to specify a glob pattern then I could have it only show certain routes and exclude the long ones.

msabramo · 2014-12-23T22:45:45Z

Why is the change so big if all you did was add a method column? I think there must be more going on here than just that. Going to check my computer for spyware now.

E.g.: $ proutes development.ini --glob='user*' Name Pattern View Method ---- ------- ---- ------ user /profilesvc/v1/user/{user_id} pyramid.config.views.<pyramid.config.views.MultiView object at 0x106f72bd0> * user /profilesvc/v1/user/{user_id} cornice.service.wrapper GET,HEAD

msabramo · 2014-12-23T23:03:29Z

If proutes allowed me to specify a glob pattern then I could have it only show certain routes and exclude the long ones.

sontek#1

$ proutes development.ini --glob='user*'
Name    Pattern                          View                                                                           Method
----    -------                          ----                                                                           ------
user    /profilesvc/v1/user/{user_id}    pyramid.config.views.<pyramid.config.views.MultiView object at 0x106f72bd0>    *
user    /profilesvc/v1/user/{user_id}    cornice.service.wrapper                                                        GET,HEAD

$ proutes development.ini --glob='get_user*'
Name                      Pattern                                  View                                                 Method
----                      -------                                  ----                                                 ------
get_user_info             /profilesvc/v1/get_user_info             profilesvc.views.user_info.get_user_info             *
get_user_questions        /profilesvc/v1/get_user_questions        profilesvc.views.user_info.get_user_questions        *
get_user_qb_categories    /profilesvc/v1/get_user_qb_categories    profilesvc.views.user_info.get_user_qb_categories    *

$ proutes development.ini --glob='appstatus*'
Name                  Pattern                                View                                  Method
----                  -------                                ----                                  ------
appstatus.status      /status{optional_slash:/?}             smlib.appstatus.ServiceStatusViews    *
appstatus.packages    /status/packages{optional_slash:/?}    smlib.appstatus.ServiceStatusViews    *
appstatus.pid         /status/pid{optional_slash:/?}         smlib.appstatus.ServiceStatusViews    *

sontek · 2014-12-24T03:05:05Z

@msabramo The reason the diff is so big is because finding the request method is not completely straightforward, it can be defined at the route level, view level, be a list of methods, a single string, or not_ function. So tracking all this logic took a little bit of work.

While working on the request method I came up with some complex routing examples that exposed bugs in the original implementation as well so I fixed those as I went along.

msabramo · 2014-12-24T20:31:08Z

Maybe if it's hard to reliably get the the method, that's an indication that something needs to be fixed in the API that proutes is using?

Fixing routing bugs might be another PR as well?

…rt_more_features_in_routes

mmerickel · 2015-01-06T05:55:18Z

Ok, finally took a look. I don't have much to say. This is awesome. Could the [proutes] format = section take the same format as the CLI instead of newline-separated? For example format = view, method? If not, why?

sontek · 2015-01-06T07:44:58Z

@mmerickel Was just trying to be consistent with things like pyramid.includes which use the newline format instead of csv, I could switch it though

…rt_more_features_in_routes Conflicts: CHANGES.txt

mmerickel · 2015-01-06T16:19:56Z

I guess I'd vote for supporting both then!

msabramo · 2015-01-21T01:41:32Z

I don't know about supporting both of them. That probably will make things confusing and possibly harder to maintain.

I think I'd stick with the newline approach as that seems to be more typical of what is used in PasteDeploy ini files, including pyramid.includes, pipeline, kotti.configurators, etc.

@sontek: This has merge conflicts that need to resolved, even if @mmerickel agrees with sticking with the newline approach.

…rt_more_features_in_routes Conflicts: CHANGES.txt

sontek · 2015-01-21T02:36:43Z

I fixed the conflict that YOU caused! ;).

I'm also not really wanting to support csv as all because its confusing to have multiple ways of doing something. I would think it would only make sense if we also support csv in things like includes and tweens

mmerickel · 2015-01-21T02:45:33Z

I'm not sure why this feature is being compared to these other things that have only one way to specify them like pyramid.includes. There is no CLI equivalent. This is turning a CLI option into an INI format. In other tools (like pip for example) you specify your .pip/pip.conf then you define the setting equivalently to how it is input at the CLI prompt and then they use the same parsing code for both.

msabramo · 2015-01-21T03:42:31Z

Well yeah but does pip use a csv command line argument or ini setting? I can't think of one.

I feel like it's more typical for CLI options to repeat the option than to have a single one with a CSV value.

But even if there is a ini file option and an equivalent CLI option, I feel like each one should use the one natural syntax for that medium and for ini files I think that's usually newlines (though I will admit that logger keys is a CSV but I think that's rarer). I don't think it's necessary for each to support the format of other

mmerickel · 2015-01-21T03:49:45Z

This isn't separate features though like every other example (multiple options on the cli, pyramid.includes, kotti.configuration, pipeline, etc). This is a format string. I think logically they should be in a csv format rather than separated by newlines because that's describing the tabular format of the output on the console.

msabramo · 2015-01-21T04:11:09Z

Pip is an interesting example. AFAICT, --extra-index-url <URL> doesn't accept CSV.

msabramo · 2015-01-21T04:17:36Z

Interesting.

What if it were a format string?

E.g.:

format = {view} {name} {command}

mmerickel · 2015-01-21T04:29:46Z

Yeah I can definitely see this evolving a bit, it's obviously a tiny format dsl. Hopefully we don't have to take it any further than the csv columns though. The CSV does indicate columns somewhat well.

sontek · 2015-01-21T04:31:00Z

Ok, I'm going to kill newline support and only do CSV. It'll be consistent between the ini and the cli

mmerickel · 2015-01-21T05:12:40Z

I asked @bertjwregger to be a sane third party if you want him to as well since I realize I'm being like ultra pedantic here. Regardless, the PR is great and I'll merge it once a decision is made.

sontek · 2015-01-21T05:27:43Z

Yeah, I prefer more input! I don't really care that much either way, I'll use whatever gets merged :)

cc @mcdonc @tseaver @pauleveritt @blaflamme @cguardia :D

digitalresistor · 2015-01-21T07:08:18Z

@mmerickel Can't even get my name right with the auto-complete ;-)

Will take a look at this tomorrow. I like the idea, and I like the output, will do a quick code review as well.

mmerickel · 2015-01-21T07:51:00Z

Crap I was so close!

sontek · 2015-01-21T17:29:31Z

@mmerickel @bertjwregeer I noticed that it didn't link so I tried to guess what the actually name was and I couldn't remember either :D

sontek · 2015-01-22T15:32:23Z

@mmerickel There, it now supports every way someone might think of using it :)

Make Proutes *AMAZING*: Fix checks for @wsgiapp2, MultiView, and add request method

mmerickel · 2015-01-22T21:53:17Z

Coolest thing ever. Merged.

msabramo · 2015-01-22T22:35:50Z

Woo hoo!

@sontek: I want that pyramid command now.

$ pyramid route list

msabramo · 2015-01-22T22:47:20Z

https://github.com/sontek/pyramid_cli

Fix checks for @wsgiapp2, MultiView, and add request method

1dfd12a

sontek added 3 commits December 14, 2014 20:27

Fix py26 support

e2274e5

Switch tox back to 2.6, was supposed to be local

59ee9f5

Added support for not_ request_method checks

228a5e5

sontek changed the title ~~Fix checks for @wsgiapp2, MultiView, and add request method~~ Make Proutes *AMAZING*: Fix checks for @wsgiapp2, MultiView, and add request method Dec 15, 2014

msabramo mentioned this pull request Dec 23, 2014

Add a --glob option to limit output sontek/pyramid#1

Closed

sontek added 2 commits December 25, 2014 19:36

Added test for the view glob

c966a92

Add the --format flag

a99d2d7

sontek mentioned this pull request Dec 26, 2014

proutes does not show static routes #1180

Closed

sontek added 7 commits December 26, 2014 05:06

Add support for static routes

582c2ed

Merge branch 'master' of https://github.com/sontek/pyramid into suppo…

538fd5c

…rt_more_features_in_routes

Updated the docs to talk about --format

22c836e

Merge branch 'master' of https://github.com/Pylons/pyramid into suppo…

35d64fd

…rt_more_features_in_routes

Updated the CHANGES to discuss these improvments.

149ea94

Fix typo

3f8ac54

Terminated the highlight on format

83a400a

Merge branch 'master' of https://github.com/Pylons/pyramid into suppo…

ae7bcd7

…rt_more_features_in_routes Conflicts: CHANGES.txt

Merge branch 'master' of https://github.com/Pylons/pyramid into suppo…

8724ab8

…rt_more_features_in_routes Conflicts: CHANGES.txt

Make more ways to configure [proutes] section

b8ba0f1

mmerickel added a commit that referenced this pull request Jan 22, 2015

Merge pull request #1488 from sontek/support_more_features_in_routes

f5a78b1

Make Proutes *AMAZING*: Fix checks for @wsgiapp2, MultiView, and add request method

mmerickel merged commit f5a78b1 into Pylons:master Jan 22, 2015

sontek mentioned this pull request Jan 22, 2015

Backport proutes improvements from 1.6 to 1.5 #1542

Merged

mmerickel added this to the 1.6 milestone Feb 6, 2015

pyup-bot mentioned this pull request Feb 26, 2017

Pin pyramid to latest version 1.8.2 nicfit/MishMash#35

Merged

pyup-bot mentioned this pull request Apr 30, 2017

Pin pyramid to latest version 1.8.3 nicfit/MishMash#94

Merged

pyup-bot mentioned this pull request Jun 30, 2017

Initial Update mozilla-services/shavar#100

Merged

pyup-bot mentioned this pull request Dec 12, 2017

Pin pyramid to latest version 1.9.1 openstax/cnx-press#6

Merged

pyup-bot mentioned this pull request Jun 30, 2020

Pin pyramid to latest version 1.10.4 camptocamp/c2cgeoportal#6622

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make Proutes AMAZING: Fix checks for @wsgiapp2, MultiView, and add request method #1488

Make Proutes AMAZING: Fix checks for @wsgiapp2, MultiView, and add request method #1488

sontek commented Dec 15, 2014

sontek commented Dec 15, 2014

msabramo commented Dec 15, 2014

msabramo commented Dec 15, 2014

sontek commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

sontek commented Dec 24, 2014

msabramo commented Dec 24, 2014

mmerickel commented Jan 6, 2015

sontek commented Jan 6, 2015

mmerickel commented Jan 6, 2015

msabramo commented Jan 21, 2015

sontek commented Jan 21, 2015

mmerickel commented Jan 21, 2015

msabramo commented Jan 21, 2015

mmerickel commented Jan 21, 2015

msabramo commented Jan 21, 2015

msabramo commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

digitalresistor commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

sontek commented Jan 22, 2015

mmerickel commented Jan 22, 2015

msabramo commented Jan 22, 2015

msabramo commented Jan 22, 2015

Make Proutes *AMAZING*: Fix checks for @wsgiapp2, MultiView, and add request method #1488

Make Proutes *AMAZING*: Fix checks for @wsgiapp2, MultiView, and add request method #1488

Conversation

sontek commented Dec 15, 2014

sontek commented Dec 15, 2014

msabramo commented Dec 15, 2014

msabramo commented Dec 15, 2014

sontek commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

msabramo commented Dec 23, 2014

sontek commented Dec 24, 2014

msabramo commented Dec 24, 2014

mmerickel commented Jan 6, 2015

sontek commented Jan 6, 2015

mmerickel commented Jan 6, 2015

msabramo commented Jan 21, 2015

sontek commented Jan 21, 2015

mmerickel commented Jan 21, 2015

msabramo commented Jan 21, 2015

mmerickel commented Jan 21, 2015

msabramo commented Jan 21, 2015

msabramo commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

digitalresistor commented Jan 21, 2015

mmerickel commented Jan 21, 2015

sontek commented Jan 21, 2015

sontek commented Jan 22, 2015

mmerickel commented Jan 22, 2015

msabramo commented Jan 22, 2015

msabramo commented Jan 22, 2015

Make Proutes AMAZING: Fix checks for @wsgiapp2, MultiView, and add request method #1488

Make Proutes AMAZING: Fix checks for @wsgiapp2, MultiView, and add request method #1488